Summarize PM_cycle_data objects — summary.PM_cycle

Summarizes the raw data (class: PM_cycle_data) from a PM_cycle object in the same way as summarizing a PM_cycle object. Both use summary.PM_cycle.

Usage

# S3 method for class 'PM_cycle_data'
summary(object, ...)

Arguments

object: A PM_cycle_data object
...: Additional arguments passed to summary.PM_cycle

Examples

# There is no example we can think of to filter or otherwise process a PM_cycle object,
# but we provide this function for completeness.
NPex$cycle$data %>% summary()
#> 
#> ── Cycle Summary ──
#> 
#> Cycle number: 100 of 100
#> Status: Stop: MaxCycles
#> Log-likelihood: 450.88
#> AIC:: 458.88
#> BIC: 462.863
#> Outeq 1: Gamma = 1.315
#> 
#> ── Normalized parameter values: 
#> # A tibble: 3 × 6
#>   cycle    ka    ke     v tlag1 stat  
#>   <dbl> <dbl> <dbl> <dbl> <dbl> <chr> 
#> 1   100 0.998  1.16 1.06  0.595 mean  
#> 2   100 5.55   1.41 0.997 2.10  sd    
#> 3   100 1.16   1.07 1.17  0.581 median
# all the below are the same
# summary(NPex$cycle$data) 
# summary(NPex$cycle)
# NPex$cycle$summary()