refresh: Refresh a package/research compendium

Description Usage Arguments Value See Also Examples

View source: R/refresh.R

Description

This function refreshes a package/research compendium. It will:

Usage

1
refresh(compendium = NULL, make = FALSE, check = TRUE, quiet = FALSE)

Arguments

compendium

a character of length 1

The name of the folder to recursively detect dependencies to be added to the Imports field of DESCRIPTION file. It can be 'analysis/' (if additional folders, i.e. data/, outputs/, figures/, etc. have been created in this folder), '.' (if folders data/, outputs/, figures/, etc. have been created at the root of the project), etc. See new_compendium() for further information.

Default is compendium = NULL (i.e. no additional folder are inspected but R/, NAMESPACE, vignettes/, and tests/ are still inspected).

make

a logical value

If TRUE the Make-like R file make.R is sourced. Only for research compendium created with new_compendium(). Default is FALSE.

check

a logical value

If TRUE (default) package integrity is checked using devtools::check().

quiet

a logical value

If TRUE (default) message are deleted.

Value

None

See Also

Other setup functions: new_compendium(), new_package(), set_credentials()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 
library(rcompendium)

## Create an R package ----
new_package()

## Start developing functions ----
## ...

## Update package (documentation, dependencies, README, check) ----
refresh()

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.