settings_list2spreadsheet: Define CWatM settings & parameters

In dof1985/cwatm4r: What the Package Does (One Line, Title Case)

Define CWatM settings & parameters

Description

This function creates a default settings spreadsheet, granting the user with complete control over all model parameters.

Usage

settings_list2spreadsheet(
  settingsList = NULL,
  output_path = "./cwatm_settings.xlsx",
  overwrite = FALSE
)

Arguments

settingsList	named list, a settingsList object (Defaults to NULL; see Details)
output_path	character vector, the settings spreadsheet's path and name
overwrite	logical. Should the function overwrite existing files?

Details

The user can choose a settingList object (e.g., as in the output of settings_ini2list()). Otherwise (if NULL) the function uses a default settingsList

Value

an MS Excel settings spreadsheet (see Details)

Examples

## Not run: 
settings_list2spreadsheet( output_path = "./cwatm_settings.xlsx", overwrite = TRUE)

## End(Not run)

dof1985/cwatm4r documentation built on Nov. 8, 2022, 7:30 p.m.