summary.clv.time: Summarizing a CLV time object

View source: R/f_s3generics_clvtime.R

print.clv.timeR Documentation

Summarizing a CLV time object

Description

Summary method for CLV time objects that provides information about the start and end date of the estimation and possible holdout sample.

Usage

## S3 method for class 'clv.time'
print(x, digits = max(3L, getOption("digits") - 3L), ...)

## S3 method for class 'clv.time'
summary(object, ...)

Arguments

x

An object of class "summary.clv.time", usually, a result of a call to summary.clv.time.

digits

The number of significant digits to use when printing.

...

Ignored.

object

A CLV time object

Value

This function computes and returns summary statistics of the time related information stored in object. It returns a list of class summary.clv.time that contains the elements:

time.unit

What time unit defines a single period.

estimation.period.in.tu

Length of estimation period in time units.

has.holdout

Whether the object has a holdout data sample.

holdout.period.in.tu

Length of holdout period in time units, if any.

See Also

summary.clv.data for how to summarize a clv data object


bachmannpatrick/CLVTools documentation built on Oct. 29, 2023, 2:16 p.m.