Add CITATION file #242
Merged
Add CITATION file #242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
evanroyrees
requested review from
evanroyrees and
chasemc
and removed request for
evanroyrees
Codecov Report
@@ Coverage Diff @@
## main #242 +/- ##
==========================================
- Coverage 27.61% 27.31% -0.30%
==========================================
Files 45 45
Lines 5334 5334
==========================================
- Hits 1473 1457 -16
- Misses 3861 3877 +16
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
chasemc
reviewed
Feb 23, 2022
chasemc
reviewed
Feb 23, 2022
chasemc
reviewed
Feb 23, 2022
chasemc
reviewed
Feb 23, 2022
chasemc
reviewed
Feb 23, 2022
chasemc
reviewed
Feb 23, 2022
chasemc
requested changes
Feb 23, 2022
There was a problem hiding this comment.
Couple things:
You made a PR against the main branch, so you'll want to go back and make a PR against the dev branch
.cff is a type of yaml file so it's sensitive to indentation (which made it really difficult to use the suggestions through github's review system)
I'll add some comments to the file you added in a second, but you'll want to make the indentation match how it is below (also changed a field). I don't think what you did was incorrect for the format, but using as below makes sure it is displayed by GitHub correctly (I tested it on a personal repository of mine)
Also, the...
title: Autometa
authors:
- family-names: Kwan
given-names: Jason C.
part can be deleted (otherwise it would be a running tab of contributors and software release info like:
https://github.com/github/docs/blob/277d335aebeb703cdbe979916ad815e7967e129c/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md?plain=1#L93-L105
cff-version: 1.2.0
message: 'If you use this software, please cite it as below.'
preferred-citation:
type: article
authors:
- given-names: Ian J.
family-names: Miller
- given-names: Evan R.
family-names: Rees
- given-names: Jennifer
family-names: Ross
- given-names: Izaak
family-names: Miller
- given-names: Jared
family-names: Baxa
- given-names: Juan
family-names: Lopera
- given-names: Robert L.
family-names: Kerby
- given-names: Federico E.
family-names: Rey
- given-names: Jason C.
family-names: Kwan
orcid: 'https://orcid.org/0000-0001-9933-1536'
title: 'Autometa: automated extraction of microbial genomes from individual shotgun metagenomes'
year: 2019
journal: Nucleic Acids Research
volume: 47
issue: 10
url: 'https://github.com/KwanLab/Autometa'
doi: 10.1093/nar/gkz148
|
happy to make the branch change. ^^ this needed to be included. At least through the context of validating the .cff with cffconvert. I originally did not have it but the validation required a title and author field in the first indentation. Maybe I can look into validating it on my personal github and/or look into a different validation package (i see there is at least one other). I can make the changes you suggested, thanks |
|
@chasemc @WiscEvan |
|
Looks good, I checked it in another repo and it shows the citation as the v1 manuscript |
chasemc
approved these changes
Mar 14, 2022
|
@WiscEvan I don't get why codecov is picking up on an unchanged file? |
I'm not sure why codecov is picking this up. It has shown some odd behavior in the past 🤷 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR checklist
nf-core lint .).nextflow run . -profile test,docker).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).