Tools: Add citation information following the citation file format

Created on 27 Jul 2019  路  8Comments  路  Source: nf-core/tools

Here at BOSC CodeFest, we got encouraged to use the human and machine-readable citation file format CFF, which provides citation metadata for software.

Please have a look at the current specification of CFF.

I want to bring this up here, so we can discuss if we want to incorporate this in our tools and pipeline repositories.

I know that @mkuzak and others are working on a Zotero browser plugin that reads CFF files to add it automatically in the bibliography. Changes are, that for other reference managers this will be possible too.

What do you think?

template

Most helpful comment

Should be easy enough to cover both, no?

All 8 comments

Sounds good! How does this compare to .bib bibTex files? Those have been around forever and are supported everywhere.

Should probably be implemented as part of https://github.com/nf-core/tools/issues/236 - that one started to get a bit complicated and stalled..

I think the bibTex specification does not cover software as a native entry type: https://en.wikipedia.org/wiki/BibTeX#Entry_types

If you have a look at the current CFF core specification, it is targeted for software. Entries like:

  • license
  • copyright
  • repository
  • repository-code
  • repository-artifact
  • software-container
  • orcid
  • ....

are some i just cherry-picked which I found super useful. You can even reference a git commit hash!

Nice! 馃憤

Should be easy enough to cover both, no?

Have you guys checked the CSL style out: https://citationstyles.org/developers/

Used it for Manubot: https://github.com/manubot/manubot

@vsmalladi if I understand correctly, CSL is another way to add citation information in a machine-readable way, it deas not address software citation per se. Is that correct?

Yes that is correct. It鈥檚 a option so that we can store citation and export to journal specific format

Alternative option is codemeta, it has a lot of crosswalks to other systems

Was this page helpful?
0 / 5 - 0 ratings

Related issues

orzechoj picture orzechoj  路  3Comments

MaxUlysse picture MaxUlysse  路  6Comments

ewels picture ewels  路  8Comments

ewels picture ewels  路  5Comments

phue picture phue  路  5Comments