Type: | Package |
Title: | A Smaller 'codemetar' Package |
Version: | 0.1.1 |
Description: | The 'Codemeta' Project defines a 'JSON-LD' format for describing software metadata, as detailed at https://codemeta.github.io. This package provides core utilities to generate this metadata with a minimum of dependencies. |
License: | GPL-3 |
URL: | https://github.com/cboettig/codemeta |
BugReports: | https://github.com/cboettig/codemeta/issues |
Depends: | R (≥ 3.0.0) |
Imports: | desc, jsonlite (≥ 1.6), methods, utils |
Suggests: | covr, knitr, rmarkdown, testthat (≥ 3.0.0) |
Encoding: | UTF-8 |
RoxygenNote: | 7.1.2 |
X-schema.org-isPartOf: | https://ropensci.org |
X-schema.org-keywords: | metadata, codemeta, ropensci, citation, credit, linked-data |
Config/testthat/edition: | 3 |
NeedsCompilation: | no |
Packaged: | 2021-12-22 00:42:36 UTC; rocker |
Author: | Carl Boettiger |
Maintainer: | Carl Boettiger <cboettig@gmail.com> |
Repository: | CRAN |
Date/Publication: | 2021-12-22 00:50:02 UTC |
write_codemeta
Description
write_codemeta
Usage
write_codemeta(
path = ".",
id = NULL,
file = "codemeta.json",
verbose = getOption("verbose", FALSE)
)
Arguments
path |
path to the package root |
id |
identifier for the package (e.g. a DOI, as URL) |
file |
output file location, should be called |
verbose |
Whether to print messages indicating the progress of internet downloads. |
Value
a codemeta list object (invisbly) and write out the codemeta.json file
Examples
# 'path' and 'out' here are for illustrative use only.
# typical use in a package is simply `wite_codemeta()` with no arguments
path <- system.file("", package="codemeta")
out <- tempfile(fileext =".json")
write_codemeta(path, file = out)