write_codemeta: write_codemeta

Description Usage Arguments Value Examples

View source: R/write_codemeta.R

Description

write_codemeta

Usage

1
2
3
4
5
6
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 codemeta.json.

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

1
2
3
4
5
6
 # '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)

codemeta documentation built on Dec. 22, 2021, 1:06 a.m.