R API

This is the class and function reference of Rcatch22. Please refer to the user guide for further details as the class and function specifications may not be sufficient to give full context on their

The Rcatch22 package provides functionality for extracting the catch22 feature set from time series data.

Functions

catch22_all

Automatically run every time-series feature calculation included in the catch22 set.

catch22_all(data, catch24 = FALSE)

Parameters

Parameter	Type	Description
data	numeric vector	A numerical vector representing the input time series.
catch24	logical	A logical value indicating whether to include the mean and standard deviation features (catch24). Default is FALSE.

Returns

A data frame containing the calculated feature values. The data frame has two columns: names (feature names) and values (corresponding feature values):

Key	Type	Description
names	list	A list of catch22/catch24 feature names.
values	list	Corresponding list of feature values.

Example Usage

data <- rnorm(100)

% features with standard catch22
features <- catch22_all(data)

% features with catch24
features_with_catch24 <- catch22_all(data, catch24 = TRUE)

---

Individual Feature Methods

The Rcatch22 package provides direct access to the individual feature extraction methods implemented in C. These methods can be called directly using their respective function names (as given by the long name in the table of features):

Syntax

% example of a single feature, replace with feature name of interest
DN_HistogramMode_5(data)

Parameters

Parameter	Type	Description
data	numeric vector	A numerical vector representing the input time series.

Returns

Value	Type	Description
value	double	Corresponding feature output.

Example Usage

data <- rnorm(100)
mode_5 <- DN_HistogramMode_5(data)
mean_value <- DN_Mean(data)

---