read_parameters {cape}R Documentation

Read the parameter file, add missing entries

Description

This function returns reads in the YAML file and checks for any parameters that might not be included. This may not matter for the given run, but it's handy to be able to check for any and all potential variables.

Usage

read_parameters(filename = "cape.parameters.yml", yaml_parameters = NULL)

Arguments

filename

full path to the .yml file holding CAPE parameters (is not needed if yaml_parameters is provided)

yaml_parameters

yaml string holding CAPE parameters (can be NULL)

Value

Returns a named list with all possible options

Examples

## Not run: 
param_table <- read_parameters()

## End(Not run)


[Package cape version 3.1.0 Index]