plotStatusDashboards: plotStatusDashboards

View source: R/Module_plotStatusDashboards.R

plotStatusDashboardsR Documentation

plotStatusDashboards

Description

this function takes outputs from generateRapidStatus() and creates 1 png file with standard diagnostics for each CU.

Usage

plotStatusDashboards(
  cu.info,
  retro.summary.tbl,
  cu.data,
  out.label = "RapidStatusOut",
  out.filepath = "",
  plot.status.timeline = TRUE
)

Arguments

cu.info

a data frame with specifications for each CU. For details, see help file for calculateMetricsByCU().

retro.summary.tbl

data frame which is the $SummaryTable component of the output from generateRapidStatus()

cu.data

a data frame with CU time series. This is the same data frame used for the cu.file argument in the call to calculateMetricsbyCU() and is included as the $Data list element in the output from that function. For details, see that help file.

out.label

label to use in the filenames for the output

out.filepath

folder for storing the output files

plot.status.timeline

Default is TRUE. If FALSE, do not plot the timeline of rapid statuses in the bottom panel


Pacific-salmon-assess/WSP-Metrics-Pkg documentation built on July 16, 2025, 1:46 p.m.