search

bycycle-tools / bycycle

Cycle-by-cycle analysis of neural oscillations.
https://bycycle-tools.github.io/
Apache License 2.0
80 stars 21 forks source link

[MRG] Citation cff #109

Closed ryanhammonds closed 2 years ago

ryanhammonds commented 3 years ago

This adds a cff file that gets added to the sidebar. The citation file requires this specific format to work, and doesn't display all of of the fields correctly (journal, issue, pages). The cff file creates a sidebar dropdown with two copy options.

APA: 

Cole S., Voytek B. (2019). Cycle-by-cycle analysis of neural oscillations (version 1.0.0). DOI: https://doi.org/10.1152/JN.00273.2019

BibTeX:

@misc{Cole_Cyclebycycle_analysis_of_2019,
author = {Cole, Scott and Voytek, Bradley},
doi = {10.1152/JN.00273.2019},
month = {1},
title = {Cycle-by-cycle analysis of neural oscillations},
url = {https://github.com/bycycle-tools/bycycle},
year = {2019}
}

We may want to wait until github sorts out this extension since the rendered citations are incomplete, despite providing the required info. Ideally, they should support standard formats other than cff.

TomDonoghue commented 2 years ago

At some point Github extended the cff files to support citations other than code / repos (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#citing-something-other-than-software).

Since I was doing this anyway for a couple other repos, I edited this one here as well.

@ryanhammonds - this should be ready to merge now, if you want to take a quick check!

ryanhammonds commented 2 years ago

@TomDonoghue, thanks for this! The citation looks good to me. Merging