select_output_variables_R: Selects RHESSys output variables

In ryanrbart/RHESSysIOinR: Tools for Running RHESSys from R

Selects RHESSys output variables

Description

Somewhat optimized R-based read and subsetting of RHESSys output

Usage

select_output_variables_R(
  output_variables,
  output_folder,
  output_filename,
  run,
  max_run = NULL,
  return_data = FALSE,
  out = NULL,
  no_write = FALSE
)

Arguments

output_variables	Datafrane with named columns: "variables" containing variables of interest found in the header of rhessys output files, "out_file" points to the files containing the associated variables, this can be either the path to that file, can use the abbreviation for the different output types (patch daily = pd, patch daily grow = pdg etc.) and the files in output_folder will be parsed appropriately, or can use the fully written out space.time suffix, e.g. "patch.daily" or "grow_patch.daily"
output_folder	Folder where rhessys output is located (e.g. 'out')
output_filename	Base file name of standard rhessys output
run	Simulation number. Used to reset files in allsim at beginning of simulation
max_run	Max number of runs to collect output for - at run == max run, output will be pivoted from long to wide, and date and spatial info will be added.
return_data	TRUE/FALSE if the function should return a data.table of the selected output - for now only works if doing 1 run
out	Output location, if not will use default "allsim" within output folder
no_write	TRUE/FALSE to only return data within R, and not write any data. Only works is return_data == TRUE

ryanrbart/RHESSysIOinR documentation built on March 30, 2024, 11:15 p.m.