activateAmendments: Activate amendments in objects of '"Project"'

In pepkit/pepr: Reading Portable Encapsulated Projects

Activate amendments in objects of "Project"

Description

This method switches between the amendments within the "Project" object

Usage

activateAmendments(.Object, amendments)

## S4 method for signature 'Project,character'
activateAmendments(.Object, amendments)

Arguments

.Object	an object of class "Project"
amendments	character with the amendment name

Details

To check what are the amendments names call listAmendments(p), where p is the object of "Project" class

Value

an object of class "Project" with activated amendments

Methods (by class)

• activateAmendments(.Object = Project, amendments = character): activate amendments in a "Project" object

Examples

projectConfig = system.file("extdata",
"example_peps-master",
"example_amendments1",
"project_config.yaml",
package = "pepr")
p = Project(file = projectConfig)
availAmendments = listAmendments(p)
activateAmendments(p, availAmendments[1])

pepkit/pepr documentation built on Nov. 23, 2023, 5:54 a.m.