Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme: CR Methods citation, and Slack badge #59

Merged
merged 3 commits into from
Jul 18, 2024
Merged

Update Readme: CR Methods citation, and Slack badge #59

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
281021a
add "join slack" badge in README
rgutzen Feb 8, 2024
090e255
replace arxiv citation with CR methods citation
rgutzen Feb 8, 2024
462dd86
Merge branch 'master' into docs/readme
mdenker Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ Collaborative Brain Wave Analysis Pipeline (Cobrawap)
:alt: DOI Latest Release
:align: left

.. image:: https://img.shields.io/badge/slack-join-pink.svg
:target: https://join.slack.com/t/cobrawapworkinggroup/shared_invite/zt-1t8fjv447-64MrlHywww97LRC1ZtW0DA
:alt: Join our Slack Community
:align: left
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:align: left
:align: right

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if "align left" would work when displayed on screen, because there are three banners in the same line now

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alignment to the left for all the elements has the effect that they are listed one after the other from left to right. You can see the rendered version of the README on the fork branch.
However, it seems that the displayed order (doi, slack, docs) is not the same as in the rst code (docs, doi, slack). I'm not sure how the display order is determined then.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't see your fork branch (I see there are 14 forks, but just mine is visible to me); my preview of the .rst code here in the github review tool shows the "slack" banner in a new line, below the others

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a link just below the PR Title.
https://github.com/rgutzen/cobrawap/tree/docs/readme


.. image:: https://raw.githubusercontent.com/NeuralEnsemble/cobrawap/master/doc/images/cobrawap_logo.png
:height: 150px
:alt: Cobrawap Logo
Expand Down Expand Up @@ -59,8 +64,7 @@ To cite a specific version of Cobrawap please see version-specific DOIs at:

To cite Cobrawap, please use:

Robin Gutzen, Giulia De Bonis, Chiara De Luca, Elena Pastorelli, Cristiano Capone, Anna Letizia Allegra Mascaro, Francesco Resta, Arnau Manasanch, Francesco Saverio Pavone, Maria V. Sanchez-Vives, Maurizio Mattia, Sonja Grün, Pier Stanislao Paolucci, Michael Denker (2024), *A modular and adaptable analysis pipeline to compare slow cerebral rhythms across heterogeneous datasets*, Cell Reports Methods,
Volume 4, Issue 1, `https://doi.org/10.1016/j.crmeth.2023.100681 <https://doi.org/10.1016/j.crmeth.2023.100681>`_
Gutzen, R., De Bonis, G., De Luca, C., Pastorelli, E., Capone, C., Allegra Mascaro, A. L., Resta, F., Manasanch, A., Pavone, F. S., Sanchez-Vives, M. V., Mattia, M., Grün, S., Paolucci, P. S., & Denker, M. (2024). *Using a modular and adaptable analysis pipeline to compare slow cerebral rhythms across heterogeneous datasets*. Cell Reports Methods, 4(1), 100681. `https://doi.org/10.1016/j.crmeth.2023.100681 <https://doi.org/10.1016/j.crmeth.2023.100681>`_


License
Expand Down