Converts a CFF file into DESCRIPTION
Path and name of the CFF file
if 'TRUE', the output is saved as DESCRIPTION (plus an extension to avoid overwriting)
CFF is a standard format for the citation of software proposed by Stephan Druskat et. al. (see references below). CFF-compliant files are stored in files named CITATION.cff.
CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software.
export = TRUE, the user can use the following arguments
to customize the output file:
The name of the exported file
TRUE, will replace any
homonymous file present on the export path
By default, the file is saved to a temporary directory. One
may provide a different path here. For example,
outpath = "." will
save to the current working directory
A CFF file converted to a DESCRIPTION file.
Druskat S., Spaaks J.H., Chue Hong N., Haines R., Baker J. (2019). Citation File Format (CFF) (version 1.1.0). DOI: http://doi.org/10.5281/zenodo.1003149
1 2 3 4 5 6 7 8 9 10 11 12 13
# Printing converted file onto R session citation_file <- system.file("CFF-CITATION.cff", package = "citation") cff2r(citation_file) # Saving converted file to temporary folder on system tempFolder <- tempdir() cff2r( citation_file, export = TRUE, outname = "converted-desc", overwrite = TRUE, outpath = tempFolder ) # Making sure the file is indeed there cat(readLines(file.path(tempFolder, "converted-desc")), sep="\n")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.