Skip to content

R package | create cff citation file from R package metadata

License

Notifications You must be signed in to change notification settings

pik-piam/citation

Repository files navigation

Software Citation Tools

R package citation, version 0.11.3

CRAN status DOI R build status codecov r-universe

Purpose and Functionality

A collection of functions to extract citation information from 'R' packages and to deal with files in 'citation file format' (https://citation-file-format.github.io/), extending the functionality already provided by the citation() function in the 'utils' package.

Installation

For installation of the most recent package version an additional repository has to be added in R:

options(repos = c(CRAN = "@CRAN@", pik = "https://rse.pik-potsdam.de/r/packages"))

The additional repository can be made available permanently by adding the line above to a file called .Rprofile stored in the home folder of your system (Sys.glob("~") in R returns the home directory).

After that the most recent version of the package can be installed using install.packages:

install.packages("citation")

Package updates can be installed using update.packages (make sure that the additional repository has been added before running that command):

update.packages()

Questions / Problems

In case of questions / problems please contact Jan Philipp Dietrich dietrich@pik-potsdam.de.

Citation

To cite package citation in publications use:

Dietrich J, Leoncio W (2024). citation: Software Citation Tools. doi: 10.5281/zenodo.3813429 (URL: https://doi.org/10.5281/zenodo.3813429), R package version 0.11.3, <URL: https://github.com/pik-piam/citation>.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {citation: Software Citation Tools},
 author = {Jan Philipp Dietrich and Waldir Leoncio},
 year = {2024},
 note = {R package version 0.11.3},
 doi = {10.5281/zenodo.3813429},
 url = {https://github.com/pik-piam/citation},
}