The constructor of a class representing a Portable Encapsulated Project

Source: R/project.R

This is a helper that creates the project with empty samples and config slots

Project(
  file = NULL,
  amendments = NULL,
  sampleTableIndex = NULL,
  subSampleTableIndex = NULL
)

Arguments

file

a string specifying a path to a project configuration YAML file

amendments

a string with the amendments names to be activated

sampleTableIndex

a string indicating the sample attribute that is used to index the sample table

subSampleTableIndex

a string indicating the sample attribute that is used to index the sample table

Value

an object of "Project"

Examples

projectConfig = system.file("extdata", "example_peps-master",
"example_amendments1", "project_config.yaml", package="pepr")
p=Project(projectConfig)
#> Loading config file: /home/runner/work/_temp/Library/pepr/extdata/example_peps-master/example_amendments1/project_config.yaml
#>   amendments: newLib,newLib2