summary.tparams_mean {hesim}

Summarize tparams_mean object

Description

The summary() method summarizes a tparams_mean object containing predicted means; summary statistics are computed for each combination of the ID variables. The print() method summarizes the object using summary.tparams_mean() and prints it to the console.

Usage

## S3 method for class 'tparams_mean'
summary(object, probs = c(0.025, 0.975), ...)

## S3 method for class 'tparams_mean'
print(x, ...)

Arguments

object, x

A tparams_mean object.

probs

A numeric vector of probabilities with values in ⁠[0,1]⁠ used to compute quantiles. By default, the 2.5th and 97.5th percentiles are computed.

...

Currently unused.

Value

A data.table with columns for (i) the ID variables, (ii) the mean of each parameter across parameter samples (mean), (iii) the standard deviation of the parameter samples (sd), and (iv) quantiles of the parameter samples corresponding to the probs argument.

See Also

See tparams_mean for an example use of the summary and print methods.