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.

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

Add CITATION.cff #405

Merged
merged 4 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
1 change: 1 addition & 0 deletions AUTHORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Tanguy Damart @ BBP
Aurélien Jaquier @ BBP
Anil Tuncel @ BBP
Darshan Mandge @ BBP
Ilkan Kilic @ BBP
29 changes: 29 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "eFEL"
doi: 10.5281/zenodo.593869
url: https://doi.org/10.5281/zenodo.593869
abstract: "The Electrophys Feature Extraction Library (eFEL) allows neuroscientists to automatically extract features from time series data recorded from neurons (both in vitro and in silico). Examples are the action potential width and amplitude in voltage traces recorded during whole-cell patch clamp experiments. The user of the library provides a set of traces and selects the features to be calculated. The library will then extract the requested features and return the values to the user."
authors:
- family-names: "Ranjan"
given-names: "Rajnish"
- family-names: "Van Geit"
given-names: "Werner"
- family-names: "Moor"
given-names: "Ruben"
- family-names: "Roessert"
given-names: "Christian"
- family-names: "Riquelme"
given-names: "Luis"
- family-names: "Damart"
given-names: "Tanguy"
- family-names: "Jaquier"
given-names: "Aurélien"
- family-names: "Tuncel"
given-names: "Anil"
- family-names: "Mandge"
given-names: "Darshan"
- family-names: "Kilic"
given-names: "Ilkan"
date-released: 2020-03-01
publisher: "Zenodo"
30 changes: 5 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<td>Citation</td>
<td>
<a href="https://doi.org/10.5281/zenodo.593869">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8146607.svg" alt="DOI"/>
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.593869.svg" alt="DOI"/>
</a>
</td>
</tr>
Expand All @@ -76,31 +76,11 @@ At the moment we provide a way to automatically compile and install the library
as a Python module. Instructions on how to compile the eFEL as a standalone C++
library can be found [here](http://efel.readthedocs.io/en/latest/installation.html#installing-the-c-standalone-library).

How to cite
===========
If you use this repository in your work, please refer to the "Cite this repository" button at the top of the repository page to get various citation formats, including APA and BibTeX.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why remove the citation block? It makes it harder for the users to easily access a citation they can use in bibtex. Also, what is the cite this repository button?

Copy link
Contributor

Choose a reason for hiding this comment

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

You can also keep the original language of the citation block:

When you use this eFEL software for your research, we ask you to cite the following publications (this includes poster presentations):

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 cite this repository button allows users to generate citations in various formats, including BibTeX. (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#about-citation-files).

This way, we only need to maintain one source for citations or do you want to keep both?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh, so it will be appearing after you merge this. I was asking because I was not able to see it. Ok, you can keep your change

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think the button should appear if you switch to this branch


Citation
========

When you use this eFEL software for your research, we ask you to cite the following publications (this includes poster presentations):

```
@article{efel,
title={eFEL},
DOI={10.5281/zenodo.593869},
url={https://doi.org/10.5281/zenodo.593869}
abstractNote={The Electrophys Feature Extraction Library (eFEL) allows neuroscientists to automatically extract features from time series data recorded from neurons (both in vitro and in silico). Examples are the action potential width and amplitude in voltage traces recorded during whole-cell patch clamp experiments. The user of the library provides a set of traces and selects the features to be calculated. The library will then extract the requested features and return the values to the user.},
publisher={Zenodo},
author={Ranjan, Rajnish and
Van Geit, Werner and
Moor, Ruben and
Rössert, Christian and
Riquelme, Juan Luis and
Damart, Tanguy and
Jaquier, Aurélien and
Tuncel, Anil},
year={2023},
month={Jul}
}
```
For detailed citation information, please refer to the `CITATION.cff <./CITATION.cff>`_ file.

Requirements
============
Expand Down
Loading