Boxplot
S4 Object Class
Boxplot-class.Rd
Objects of class Boxplot
are used to store information for the Boxplot and Violin plots.
Like all S4 objects in Slick
, slots in this object can be accessed and
assigned using functions corresponding to slot name. See Boxplot()
and the
the See Also
section below.
Details
Objects of class Boxplot
are created with Boxplot()
Slots
Code
A short code for the Performance Indicators for this object. A character string length
nPI
or a named list for multi-language support. SeeDetails
Label
A short label for the Performance Indicators for this object. Used to label axes on charts. Can be longer than
Code
but recommended to keep short as possible so it shows clearly in plots and tables. A character string lengthnPI
or a named list for multi-language support. SeeDetails
Description
A description for the Performance Indicators for this object. Can include Markdown, see
Examples
. A character string lengthnPI
or a named list for multi-language support. SeeDetails
Value
A numeric array with the stochastic performance indicator values for each simulation (sim), operating model (OM), management procedure (MP), and performance indicator (PI). Dimensions: c(
nsim
,nOM
,nMP
, andnPI
).Preset
An optional named list for the preset buttons in the
App()
. The name of the list element will appear as a button in theApp()
.Defaults
A list object with default selections for the Boxplot. See
Boxplot()
Examples
boxplot <- Boxplot(Code=c('PI1', 'PI2', 'PI3'),
Label=c('Performance Indicator 1',
'Performance Indicator 2',
'Performance Indicator 3'),
Description = c('This is the description for PI 1',
'This is the description for PI 2',
'This is the description for PI 3'),
Value=array(runif(3000), dim=c(10, 10, 10,3)),
Preset=list('PI and P2'=1:2)
)
boxplot
#>
#> ── An object of class `Boxplot` ────────────────────────────────────────────────
#>
#> ── `Code` ──
#>
#> 1 PI1
#> 2 PI2
#> 3 PI3
#>
#> ── `Label` ──
#>
#> 1 Performance Indicator 1
#> 2 Performance Indicator 2
#> 3 Performance Indicator 3
#>
#> ── `Description` ──
#>
#> 1 This is the description for PI 1
#> 2 This is the description for PI 2
#> 3 This is the description for PI 3
#>
#> ── `Value` ──
#>
#> Dimension Length
#> 1 nsim 10
#> 2 nOM 10
#> 3 nMP 10
#> 4 nPI 3
#>
#> ℹ Mean across MPs and PIs
#> PI1 PI2 PI3
#> MP 1 0.47 0.53 0.46
#> MP 2 0.56 0.50 0.49
#> MP 3 0.52 0.47 0.45
#> MP 4 0.53 0.45 0.47
#> MP 5 0.48 0.49 0.52
#> MP 6 0.49 0.55 0.44
#> MP 7 0.54 0.49 0.49
#> MP 8 0.49 0.46 0.51
#> MP 9 0.47 0.55 0.57
#> MP 10 0.48 0.52 0.49
#>
#> ── `Preset` ──
#>
#> ── PI and P2
#> 1
#> 2
Code(boxplot)
#> [1] "PI1" "PI2" "PI3"
Metadata(boxplot)
#> Code Label Description
#> 1 PI1 Performance Indicator 1 This is the description for PI 1
#> 2 PI2 Performance Indicator 2 This is the description for PI 2
#> 3 PI3 Performance Indicator 3 This is the description for PI 3
# Value(boxplot)
Value(boxplot) <- array()
Preset(boxplot)
#> $`PI and P2`
#> [1] 1 2
#>
Preset(boxplot) <- list()
boxplot
#>
#> ── An object of class `Boxplot` ────────────────────────────────────────────────
#>
#> ── `Code` ──
#>
#> 1 PI1
#> 2 PI2
#> 3 PI3
#>
#> ── `Label` ──
#>
#> 1 Performance Indicator 1
#> 2 Performance Indicator 2
#> 3 Performance Indicator 3
#>
#> ── `Description` ──
#>
#> 1 This is the description for PI 1
#> 2 This is the description for PI 2
#> 3 This is the description for PI 3
#>
#> ── `Value` ──
#>
#> ── `Preset` ──
#>