listAmendments: List amendments

Description Usage Arguments Details Value Methods (by class) Examples

Description

Lists available amendments within a "Project" object.

Usage

1
2
3
4
listAmendments(.Object)

## S4 method for signature 'Project'
listAmendments(.Object)

Arguments

.Object

an object of "Project"

Details

The amendments can be activated by passing their names to the activateAmendments method

Value

names of the available amendments

Methods (by class)

Examples

1
2
3
4
5
6
7
projectConfig = system.file("extdata",
"example_peps-master",
"example_amendments1",
"project_config.yaml",
package = "pepr")
p = Project(file = projectConfig)
availAmendemtns = listAmendments(p)

Example output

Registered S3 method overwritten by 'pryr':
  method      from
  print.bytes Rcpp
Loading config file: /usr/lib/R/site-library/pepr/extdata/example_peps-master/example_amendments1/project_config.yaml
  amendments: newLib,newLib2
  amendments: newLib,newLib2

pepr documentation built on Jan. 13, 2021, 3:50 p.m.