diag_hisafe_cells: Plot cells diagnostics of Hi-sAFe output

Description Usage Arguments Value See Also Examples

View source: R/diagnostics.R

Description

Creates a tile plot of every Hi-sAFe cells output variable. All plots are saved as png files to a specifified output path.

Usage

1
2
3
4
5
6
7
diag_hisafe_cells(
  hop,
  dates = unique(grep("-07-01", as.character(hop$cells$Date), value = TRUE))[seq(1, 40,
    5)],
  output.path = NULL,
  ...
)

Arguments

hop

An object of class "hop" or "face" containing output data from one or more Hi-sAFe simulations.

dates

A character vector (in the format "YYYY-MM-DD") or a vector of class Date of the dates to include.

output.path

A character stting indicating the path to the directory where plots should be saved. Plots are saved in a subdirectory within this directory named /annualCells If no value is provided, the experiment/simulation path is read from the hop object, and a directory is created there called "analysis/diagnostics".

...

Other arguments passed to plot_hisafe_cells.

Value

Invisibly returns a list of ggplot objects.

See Also

Other hisafe diagnostic fucntions: diag_hisafe_annualcells(), diag_hisafe_monthcells(), diag_hisafe_ts(), diag_hisafe_voxels()

Examples

1
2
3
4
5
6
7
8
## Not run: 
# After reading in Hi-sAFe simulation data via:
mydata <- read_hisafe(path = "mydir", simu.names = "MySimulation")

# You can create tile plots of every annualCells variable:
diag_hisafe_cells(mydata, "2000-07-01")

## End(Not run)

kevinwolz/hisafer documentation built on Oct. 19, 2020, 4:43 p.m.