csr_make_release: Make a new COSORE release based on current package datasets.

Description Usage Arguments Details Value Note

View source: R/release.R

Description

Make a new COSORE release based on current package datasets.

Usage

1
2
3
4
5
6
7
8
9
csr_make_release(
  path,
  vignette_rebuilt = FALSE,
  force = FALSE,
  run_report = TRUE,
  zip_release = TRUE,
  datasets = list_datasets(),
  sys_call = system2
)

Arguments

path

Path to write files to; must already exist

vignette_rebuilt

Has vignette been rebuilt? Logical

force

Ignore git dirty status? Logical

run_report

Include combined_report.Rmd in release? For testing

zip_release

Run /codeutils::zip() on output files? For testing

datasets

Datasets to include, character; used for testing

sys_call

System call to use, function; testing only; normally system2

Details

To make a new release, the git working directory must be clean (unless force = TRUE), a path must be specified, and there should be file descriptors (in the code) for all files that will be zipped into the release; this information is inserted into the README.md file. Dynamic information like the current date, git commit hash, database version, and database size are all copied into README.md as well.

Value

Fully qualified name of zip file containing release.

Note

If a CSR_EMBARGO field exists in the DESCRIPTION file, no data will be released from that dataset.


bpbond/cosore documentation built on July 20, 2021, 3:17 p.m.