vpcstats: Compute VPC statistics

In tidyvpc: VPC Percentiles and Prediction Intervals

Compute VPC statistics

Description

Compute prediction interval statistics for VPC.

Usage

vpcstats(o, ...)

## S3 method for class 'tidyvpcobj'
vpcstats(
  o,
  vpc.type = c("continuous", "categorical"),
  qpred = c(0.05, 0.5, 0.95),
  ...,
  conf.level = 0.95,
  quantile.type = 7
)

Arguments

o	A tidyvpcobj.
...	Other arguments to include.
vpc.type	Character specifying type of VPC (e.g., "continuous" (Default) or "categorical").
qpred	Numeric vector of length 3 specifying quantile prediction interval. Only applicable for vpc.type = "continuous".
conf.level	Numeric specifying confidence level.
quantile.type	Numeric indicating quantile type. See quantile.

Value

Updates tidyvpcobj with stats data.table object, which contains the following columns:

• bin: Resulting bin value as specified in binning() function

• xbin: Midpoint x-value of the observed data points in the bin as specified in xbin argument of binning() function

• qname: Quantiles specified in qpred. Only returned if vpc.type = "continuous"

• pname: Categorical probability names. Only returned if vpc.type = "categorical"

• y: Observed y value for the specified quantile

• lo: Lower bound of specified confidence interval for y value in simulated data

• md: Median y value in simulated data

• hi: Upper bound of specified confidence interval for y value in simulated data

See Also

observed simulated censoring stratify binning binless predcorrect

tidyvpc documentation built on April 4, 2025, 12:14 a.m.