README.md

In ocbe-uio/RCFF: R Citation File Format

:warning: The code on this project has been merged into the CRAN-released citation. I encourage you to use that package instead. This repository is schedule for archival.

What is a CFF?

CFF stands for Citation File Format, a scientific standard that facilitates the gathering of software metadata for citation purposes.

For more information, please visit:

• The Citation File Format homepage: https://citation-file-format.github.io/
• Detailed CFF documentation
• An online CITATION.cff file initializer

RCFF

This package follows up on a proposal shared on the citation-file-format GitHub page by providing tools to convert between the standardized Citation File Format (CFF) and the structure of an R package DESCRIPTION file.

Installation and Usage

This package is still very early in development, but you can still install it and take it for a spin at your own risk.

Install the development version of RCFF with

remotes::install_github("ocbe-uio/RCFF")

and run

r2cff()

To see part of the package's description file converted to CFF. You can also provide the path (absolute or relative) to some other DESCRIPTION file to test it. Moreover, example(r2cff()) will also provide an example of how to use the package.

General information about the package can be found on ?RCFF.

ocbe-uio/RCFF documentation built on Dec. 22, 2021, 4:13 a.m.