Submitting a new package prior to publication
1
0
Entering edit mode
Krutik Patel ▴ 10
@kpatel5-22049
Last seen 5 months ago
Newcastle University, UK

Hello Bioconductor Forum,

I am about to submit my first package to bioconductor as a part of my PhD. I am aiming to get my package on bioconductor and then write a publication for it to a journal. This would mean I do not have a citation to add to the INST directory. Is it OK not to have a citation at this point? Should I just add an authors file on the INST directory instead of a citation file?

What have other developers done in this situation?

Best

Krutik

package-creation citation submit-package • 238 views
2
Entering edit mode
shepherl 3.2k
@lshep
Last seen 7 hours ago
United States

It is not required to have a citation in the INST directory. It can be added at any time. Packages receive a generic citation if there is none found in INST.
For example BiocFileCache does not have a citation file so the suggested citation that is automatically generated:

Citation (from within R, enter citation("BiocFileCache")):
Shepherd L, Morgan M (2019). BiocFileCache: Manage Files Across Sessions. R package version 1.10.2.

1
Entering edit mode

Also for what it's worth - when you submit your paper (assumingly you get your package on Bioconductor) we suggest using a short url for the package (ie. https://bioconductor.org/packages/::packageName::) as this will link to the release version of bioconductor if available and devel if not. Cheers