dot-getParam: Extract parameter value(s) from a parameter file
In leca-dev/RFate: FATE with R

.getParam

R Documentation

Extract parameter value(s) from a parameter file

Description

This function extracts from a text file the value(s) of a given parameter.

Usage

.getParam(params.lines, flag, flag.split, is.num = TRUE)

Arguments

`params.lines`	a `string` corresponding to the name of the file from which to extract the parameter value
`flag`	a `string` corresponding to the parameter name to be extracted and that must be present into the `param.lines` file
`flag.split`	a `string` to choose the concerned type of parameter (either "" or "`^--.*--$`"), depending on the type of parameter file (containing values or filenames)
`is.num`	default `TRUE`. If `TRUE`, the extracted parameter is considered to be `numeric` and will be processed as such

Value

A vector containing one or more values of type string (if is.num = FALSE) or numeric (if is.num = TRUE).

Author(s)

Damien Georges, Maya Guéguen

Examples


## Create a skeleton folder with the default name ('FATE_simulation')
if (dir.exists("FATE_simulation")) unlink("FATE_simulation", recursive = TRUE)
PRE_FATE.skeletonDirectory()

## Create a Global_parameters file
PRE_FATE.params_globalParameters(name.simulation = "FATE_simulation"
                                 , required.no_PFG = 6
                                 , required.no_strata = 5
                                 , required.simul_duration = 100
                                 , required.seeding_duration = c(10,50)
                                 , required.seeding_timestep = 1
                                 , required.seeding_input = 100
                                 , required.max_abund_low = 30000
                                 , required.max_abund_medium = 50000
                                 , required.max_abund_high = 90000)
                                 
## Extract number of PFG
.getParam(params.lines = "FATE_simulation/DATA/GLOBAL_PARAMETERS/Global_parameters_V1.txt"
          , flag = "NO_PFG"
          , flag.split = " "
          , is.num = TRUE)


## ----------------------------------------------------------------------------------------- ##
                                
## Load example data

leca-dev/RFate documentation built on Sept. 19, 2024, 6:09 a.m.