read_hisafe: Read output from one or more Hi-sAFe simulations
In kevinwolz/hisafer: An R Toolbox for the Hi-sAFe Biophysical Agroforestry Model

Description Usage Arguments Value Examples

Reads the designated output profiles from one or more Hi-sAFe simulations

read_hisafe(
  hip = NULL,
  path = NULL,
  simu.names = "all",
  profiles = "all",
  show.progress = TRUE,
  read.inputs = TRUE,
  max.size = 300,
  date.min = NA,
  date.max = NA,
  dates = NULL
)

`hip`	An object of class "hip". To create a hip object see `define_hisafe`. If `hip` is not provided, then `path` is required and the input data for the experiment is read from the experiment summary .csv file created when building the experiment.
`path`	A character string of the path to the directory containing the Hi-sAFe simulation folders. If `hip` is not provided, then `path` is required. If `hip` is provided, `path` is ignored.
`simu.names`	A character vector of the names of the simulations to read. If "all", the default, then all simulations in the folder are read.
`profiles`	A character vector of the names of Hi-sAFe output profiles to read. #' If "all" the default, reads all supported Hi-sAFe output profiles. For currently supported profiles see: `hisafe_profiles`
`show.progress`	Logical indicating whether progress messsages should be printed to the console.
`read.inputs`	Logical indicating whether data should be read from the .PLD and .SIM files for the tree.info and plot.info data slots. Setting this to `FALSE` severly limits hisafer's plotting/analysis capacity. Should only be set to `FALSE` if input files are corrupted.
`max.size`	The maximum file size (MB) that should be read. Files larger than this value will be ignored, with a warning.
`date.min`	A character string of the minimum date to keep, in the format "YYYY-MM-DD". If NA, the minimum date in the output data is used. Only used if `dates` is `NULL`.
`date.max`	A character string of the maximum date to keep, in the format "YYYY-MM-DD". If NA, the maximum date in the output data is used. Only used if `dates` is `NULL`.
`dates`	A character vector (in the format "YYYY-MM-DD") or a vector of class Date of the dates to keep. If `NULL`, then `date.max` and `date.min` are used instad.

An object of class "hop". This is a list of 12 data frames (tibbles):

trees
plot
climate
cells
monthCells
annualCells
voxels
plot.info - plot geometry data for each simulation
tree.info - tree species and location data for each simulation
exp.plan - the exp.plan of the hip object that generated the simulations
metadata - the metadata of each simulations (path to simulation folders, model versions, run date , run duration)
path - the path to the experiment/simulation folders

## Not run: 
# Reading in Hi-sAFe simulation:
myexp <- read_hisafe(myhip)

# If only the tree data is required:
mytreeexp <- read_hisafe(myhip, profiles = "trees")

## End(Not run)