Skip to contents

Function to access parameter descriptions and units used in ConFluxPro

Usage

cfp_parameter(x = NULL)

Arguments

x

Any object or data.frame to match the parameters to, or a character vector of parameter names.

Value

A data.frame() with the name, description and unit of the parameter

Examples

#list parameters within an object
cfp_parameter(soilphys)
#> 
#> This object contains the following parameters:
#>     name                    description     unit
#> 2    gas                name of the gas     <NA>
#> 3  depth  depth, higher values point up       cm
#> 4  upper          upper border of layer       cm
#> 5  lower          lower border of layer       cm
#> 6    TPS               total pore space  vol/vol
#> 7   AFPS          air-filled pore space  vol/vol
#> 8    SWC             soil water content  vol/vol
#> 9      t                    temperature       °C
#> 10     p                       pressure      hPa
#> 11  DSD0           relative diffusivity        1
#> 12    DS apparent diffusion coefficient m^2 s^-1
#> 13    D0   diffusion coefficient in air m^2 s^-1
#> 14 c_air          number density of air mol m^-3
cfp_parameter(gasdata)
#> 
#> This object contains the following parameters:
#>    name                   description unit
#> 1 x_ppm        mole fraction of a gas  ppm
#> 2   gas               name of the gas <NA>
#> 3 depth depth, higher values point up   cm

#list all paramters
cfp_parameter()
#>            name                                          description
#> 1         x_ppm                               mole fraction of a gas
#> 2           gas                                      name of the gas
#> 3         depth                        depth, higher values point up
#> 4         upper                                upper border of layer
#> 5         lower                                lower border of layer
#> 6           TPS                                     total pore space
#> 7          AFPS                                air-filled pore space
#> 8           SWC                                   soil water content
#> 9             t                                          temperature
#> 10            p                                             pressure
#> 11         DSD0                                 relative diffusivity
#> 12           DS                       apparent diffusion coefficient
#> 13           D0                         diffusion coefficient in air
#> 14        c_air                                number density of air
#> 15         flux                                         flux density
#> 16           F0                incoming flux density at model bottom
#> 17         prod                        production rate (source term)
#> 18         conc                                 number concentration
#> 19         pmap  integer, mapping unique production rates 1 = lowest
#> 20        sp_id       id of the soilphys profile in a cfp_dat object
#> 21      step_id id of each step within a soilphys profile 1 = lowest
#> 22      prof_id      id of distinct profiles within a cfp_dat object
#> 23         RMSE                               real mean square error
#> 24       lowlim              lower limit for production optimisation
#> 25      highlim              upper limit for production optimisation
#> 26 layer_couple                     coupling factor with layer below
#> 27        layer                                           layer name
#> 28     group_id     id for each combination of id_cols in layers_map
#> 29       efflux              efflux at the soil/atmosphere interface
#> 30     prod_abs                        production rate (source term)
#> 31     prod_rel                   ratio of production rate to efflux
#>              unit
#> 1             ppm
#> 2            <NA>
#> 3              cm
#> 4              cm
#> 5              cm
#> 6         vol/vol
#> 7         vol/vol
#> 8         vol/vol
#> 9              °C
#> 10            hPa
#> 11              1
#> 12       m^2 s^-1
#> 13       m^2 s^-1
#> 14       mol m^-3
#> 15 µmol m^-2 s^-1
#> 16 µmol m^-2 s^-1
#> 17 µmol m^-3 s^-1
#> 18      µmol m^-3
#> 19           <NA>
#> 20           <NA>
#> 21           <NA>
#> 22           <NA>
#> 23           <NA>
#> 24 µmol m^-3 s^-1
#> 25 µmol m^-3 s^-1
#> 26           <NA>
#> 27           <NA>
#> 28           <NA>
#> 29 µmol m^-2 s^-1
#> 30 µmol m^-2 s^-1
#> 31              1