Read a {clairvoyant} project — read

Read a {clairvoyant} project

Usage

read_project(
  x,
  extension = c("yml", "yaml"),
  pattern = NULL,
  recursive = TRUE,
  ignoreRegex = NULL,
  silent = clairvoyant::opts$get("silent"),
  rlWarn = clairvoyant::opts$get("rlWarn")
)

Arguments

x
extension
pattern
recursive
silent

Value

A {clairvoyant} project object

Examples

### Get the path to an example project
exampleProjectPath <-
  system.file(
    "example1",
    package = "clairvoyant"
  );

### Import it, showing what's being done
exampleProject <-
  clairvoyant::read_project(
    exampleProjectPath,
    silent = FALSE
  );
#> 
#> Retrieved file list in project directory '/tmp/RtmpwQvVDJ/temp_libpathff498259dbea0/clairvoyant/example1': 12 YAML files found.
#> Starting to read files from disk.
#>   - Importing file 'assertion---prevalence_source1.yml'...
#>   - Importing file 'assertion---prevalence_source2.yml'...
#>   - Importing file 'assertion---prevalence_source3.yml'...
#>   - Importing file 'assertion---prevalence_source4.yml'...
#>   - Importing file 'assertion---productionCosts---source5.yml'...
#>   - Importing file 'assertion---productionCosts---source6.yml'...
#>   - Importing file 'assertion---productionCosts---source7.yml'...
#>   - Importing file 'assertion---productionCosts---source8.yml'...
#>   - Importing file 'model---basic_model.yml'...
#>   - Importing file 'project---dealing_with_drugs.yml'...
#>   - Importing file 'scenario---policy_model_1.yml'...
#>   - Importing file 'scenario---policy_model_2.yml'...
#> 
#> Read files from disk. Starting to parse contents as YAML.
#>   - Parsing file 'assertion---prevalence_source1.yml'...
#>   - Parsing file 'assertion---prevalence_source2.yml'...
#>   - Parsing file 'assertion---prevalence_source3.yml'...
#>   - Parsing file 'assertion---prevalence_source4.yml'...
#>   - Parsing file 'assertion---productionCosts---source5.yml'...
#>   - Parsing file 'assertion---productionCosts---source6.yml'...
#>   - Parsing file 'assertion---productionCosts---source7.yml'...
#>   - Parsing file 'assertion---productionCosts---source8.yml'...
#>   - Parsing file 'model---basic_model.yml'...
#>   - Parsing file 'project---dealing_with_drugs.yml'...
#>   - Parsing file 'scenario---policy_model_1.yml'...
#>   - Parsing file 'scenario---policy_model_2.yml'...
#> 
#> Parsed files. Looking for project specification.
#> 
#> Found project information. The project identifier is 'dealing_with_drugs' and the title is ''.
#> 
#> Starting to process models.
#>   - Found model with identifier 'basic_model'.
#> Imported 1 models.
#> 
#> Starting to process scenarios.
#>   - Found scenario with identifier 'policy_model_1'.
#>   - Found scenario with identifier 'policy_model_2'.
#> Imported 2 scenarios.
#> 
#> Starting to process assertions.
#>   - Found assertion with identifier 'prevalence_source1'.
#>   - Found assertion with identifier 'prevalence_source2'.
#>   - Found assertion with identifier 'prevalence_source3'.
#>   - Found assertion with identifier 'prevalence_source4'.
#>   - Found assertion with identifier 'productionCosts_source5'.
#>   - Found assertion with identifier 'productionCosts_source6'.
#>   - Found assertion with identifier 'productionCosts_source7'.
#>   - Found assertion with identifier 'productionCosts_source8'.
#> Imported 8 assertions.
#> Reorganizing assertions by parameter.
#> Reorganized assertions.
#> Reorganizing scenarios.
#> Reorganized scenarios.
#> Reorganizing project-level parameter information.
#> Reorganized project-level parameter information.