Closed goldingn closed 8 years ago
+1
I'm guessing this depends on #284 to some extent, since we'll need to parse the roxygen block to get these data
ZoonCitation('PrintMap')
To cite the PrintMap module in publications use:
ZOON Developers, James Campbell (2016). Output module: PrintMap. Zoon module version: 1.1. Available at: https://raw.githubusercontent.com/zoonproject/modules/master/R/PrintMap.R
A BibTeX entry for LaTeX users is:
@Manual{
title = {Output module: PrintMap}
author = {ZOON Developers and James Campbell}
year = {2016}
note = {Zoon module version: 1.1}
url = {https://raw.githubusercontent.com/zoonproject/modules/master/R/PrintMap.R}
}
perfect!
Note that we will probably want to change the URL in the future once the website is finalised.
R provides
citation()
to help users cite packages (and help package maintainers get cited). E.g.:We'd like modules to be cited, so a function to help with that would be great.
citation()
uses the package DESCRIPTION file, we'd probably have to scrape the module helpfile from the repo. Presumably this could use the same code as for the website @AugustT?I had initially though we could overload
citation()
directly, but A) it's not class specific, so users would get a warning saying it was using ours, not the one inutils
and B) there would probably be name conflicts between modules and packages.Instead we could define function
ZoonCitation()
or similar with results like this:Some support for citing the specific version used would be helpful too.
Some way of extracting citations for all of the modules used in a workflow would then be useful (and easy to do)