summary.resp_indicator: Summary function for resp_indicator objects

View source: R/s3_methods.R

summary.resp_indicatorR Documentation

Summary function for resp_indicator objects

Description

Summarizes results of resp_* functions.

Usage

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

Arguments

object

An object of type resp_indicator created with a resp_* function.

quantiles

A numeric vector with values raning from 0 to 1. Determines the quantiles which are calculated. Default is c(0,0.25,0.5,0.75,1).

...

Additional arguments (currently not supported).

Value

A resp_indicator summary object. Works like a list with two elements:

  • quantile_estimates. A dataframe of estimated quantiles for the response quality indicators calculated.

  • mean_estimates. A named vector with means of response quality indicators calculated.

Examples

resp_distributions(nep) |> summary()



resquin documentation built on June 27, 2025, 9:07 a.m.