summary.cardiFit {cardidates}R Documentation

Summary Method for cardiFit Objects

Description

This function is a top-level function to extract main results from cardinal date objects fitted with fitweibull4 or fitweibull6.

Usage

## S3 method for class 'cardiFit'
summary(object, xmin = 0, xmax = 365, quantile = 0.05, symmetric = FALSE, ...)

Arguments

object

an object resulting from a call to fitweibull6 or fitweibull4,

xmin

left boundary (in day of year) of the integral under the curve

xmax

right boundary (in day of year) of the integral under the curve

quantile

two-sided quantile (percentage of integral) which defines beginning and end of the peak,

symmetric

if (TRUE), quantiles are calculated for the whole area under the curve, otherwise for each of the branches separately,

...

for compatibility only.

Details

See CDW fro a detailed description of function parameters.

See Also

weibull4, weibull6, fitweibull, peakwindow, cardidates

Examples

## create some test data
set.seed(123)
x <- seq(0, 360, length = 20)
y <- abs(rnorm(20, mean = 1, sd = 0.1))
y[5:10] <- c(2, 4, 7, 3, 4, 2)

## fit Weibull function with 6 free parameters
res <- fitweibull6(x, y)

## see the results
plot(res)
summary(res)

[Package cardidates version 0.4.8 Index]