CFfactor_coverage {CFtime}

Coverage of time elements for each factor level

Description

This function calculates the number of time elements, or the relative coverage, in each level of a factor generated by CFfactor().

Usage

CFfactor_coverage(cf, f, coverage = "absolute")

Arguments

cf

CFtime. An instance of CFtime.

f

factor or list. A factor or a list of factors derived from the parameter cf. The factor or list thereof should generally be generated by the function CFfactor().

coverage

"absolute" or "relative".

Value

If f is a factor, a numeric vector with a length equal to the number of levels in the factor, indicating the number of units from the time series in cf contained in each level of the factor when coverage = "absolute" or the proportion of units present relative to the maximum number when coverage = "relative". If f is a list of factors, a list with each element a numeric vector as above.

Examples

cf <- CFtime("days since 2001-01-01", "365_day", 0:364)
f <- CFfactor(cf, "dekad")
CFfactor_coverage(cf, f, "absolute")