Skip to contents

prj_parameter

prj_parameter.Rd

tag: parameter

Usage

prj_parameter(
  name,
  type,
  value = NULL,
  values = NULL,
  curve = NULL,
  parameter = NULL,
  group_id_property = NULL,
  field_name = NULL,
  mesh = NULL,
  time_series = NULL,
  use_local_coordinate_system = NULL,
  range = NULL,
  seed = NULL,
  ...
)

Arguments

name

string:

type

string:

value

Optional: string | double: Parameter value

values

Optional: string | double: Parameter values

curve

Optional: string:

parameter

Optional: string:

group_id_property

Optional: string:

field_name

Optional: string:

mesh

Optional: string:

time_series

Optional: list:

use_local_coordinate_system

Optional: string, "true" | "false":

range

Optional: list

seed

Optional: number

...

Optional: for index_values and expression tags (since there can be multiple)

Examples

prj_parameter(name = "zero",
                 type = "Constant",
                 value = 0)
#> $name
#> [1] "zero"
#> 
#> $type
#> [1] "Constant"
#> 
#> $value
#> [1] 0
#> 
#> $values
#> NULL
#> 
#> $curve
#> NULL
#> 
#> $parameter
#> NULL
#> 
#> $group_id_property
#> NULL
#> 
#> $index_values
#> list()
#> 
#> $field_name
#> NULL
#> 
#> $mesh
#> NULL
#> 
#> $expression
#> list()
#> 
#> $time_series
#> NULL
#> 
#> $use_local_coordinate_system
#> NULL
#> 
#> $range
#> NULL
#> 
#> $seed
#> NULL
#> 
#> $xpath
#> [1] "parameters/parameter"
#> 
#> $attr_names
#> character(0)
#> 
#> $flatten_on_exp
#> [1] "values" "range" 
#> 
#> $unwrap_on_exp
#> [1] "index_values" "expression"  
#> 
#> attr(,"class")
#> [1] "prj_parameter"

prj_parameter(name = "flux_in",
                 type = "Constant",
                 value = 1e-04)
#> $name
#> [1] "flux_in"
#> 
#> $type
#> [1] "Constant"
#> 
#> $value
#> [1] 1e-04
#> 
#> $values
#> NULL
#> 
#> $curve
#> NULL
#> 
#> $parameter
#> NULL
#> 
#> $group_id_property
#> NULL
#> 
#> $index_values
#> list()
#> 
#> $field_name
#> NULL
#> 
#> $mesh
#> NULL
#> 
#> $expression
#> list()
#> 
#> $time_series
#> NULL
#> 
#> $use_local_coordinate_system
#> NULL
#> 
#> $range
#> NULL
#> 
#> $seed
#> NULL
#> 
#> $xpath
#> [1] "parameters/parameter"
#> 
#> $attr_names
#> character(0)
#> 
#> $flatten_on_exp
#> [1] "values" "range" 
#> 
#> $unwrap_on_exp
#> [1] "index_values" "expression"  
#> 
#> attr(,"class")
#> [1] "prj_parameter"