Read and inspect scenario master files

Source: R/read_scenario_master.R

A function to read and inspect the scenario master files and obtain a master formatted list.

read.scenario_master(
  workdir,
  scenario_master_file,
  isobxr_master_file = "0_ISOBXR_MASTER"
)

Arguments

workdir

Working directory of isobxr excel master file and where output files will be stored if exported by user. (character string)

scenario_master_file

Name of scenario excel master file. (without file "xlsx" extension).

isobxr_master_file

Name of isobxr excel master file. (without file "xlsx" extension). Default is "0_ISOBXR_MASTER".

Value

List of formatted scenario master inputs.

Examples

read.scenario_master(workdir = "/Users/username/Documents/1_ABC_tutorial",
                     scenario_master_file = "0_SCENARIO_source_change",
                     isobxr_master_file = "0_ISOBXR_MASTER")
#> $RUN_SEQUENCE
#>   RUN_n t_max n_steps        flux_list coeff_list
#> 1     1 25000      25 Fx6_ABC_open_bal         a1
#> 2     2  1000     100 Fx6_ABC_open_bal         a1
#> 3     3  1000     100 Fx6_ABC_open_bal         a1
#> 4     4  1000     100 Fx6_ABC_open_bal         a1
#> 
#> $FORCING_RAYLEIGH
#> [1] RUN_n   XFROM   XTO     YFROM   YTO     AFROM   ATO     ALPHA_0
#> <0 rows> (or 0-length row.names)
#> 
#> $FORCING_SIZE
#> [1] RUN_n   BOX_ID  SIZE.t0
#> <0 rows> (or 0-length row.names)
#> 
#> $FORCING_DELTA
#>   RUN_n BOX_ID DELTA.t0
#> 1     1 SOURCE        1
#> 2     2 SOURCE        0
#> 3     3 SOURCE        1
#> 4     4 SOURCE        0
#> 
#> $FORCING_ALPHA
#> [1] RUN_n FROM  TO    ALPHA
#> <0 rows> (or 0-length row.names)
#>