curve_boxplot: Curve Boxplot

View source: R/curve_boxplot.R

curve_boxplotR Documentation

Curve Boxplot

Description

This function computes the required statistics for building up a boxplot of the aligned curve data. The computed boxplot focuses on the aligned curves.

Usage

curve_boxplot(
  x,
  alpha = 0.05,
  range = 1,
  what = c("stats", "plot", "plot+stats"),
  ...
)

Arguments

x

An object of class fdacurve typically produced by curve_srvf_align()

alpha

A numeric value specifying the quantile value. Defaults to 0.05 which uses the 95\% quantile.

range

A positive numeric value specifying how far the plot whiskers extend out from the box. The whiskers extend to the most extreme data point which is no more than range times the interquartile range from the box. Defaults to 1.0.

what

A string specifying what the function should return. Choices are "plot", "stats" or "plot+stats". Defaults to "plot".

...

Unused here.

Details

The function returns optionally an object of class either curvebox

Value

If what contains stats, a list containing the computed statistics necessary for drawing the boxplot. Otherwise, the function simply draws the boxplot and no object is returned.

Examples

## Not run: 
out <- curve_srvf_align(beta[, , 1, ], ms="median")
curve_boxplot(out, what = "stats")

## End(Not run)

fdasrvf documentation built on Oct. 5, 2024, 1:08 a.m.