# Rcatch22

R package for the calculation of 22 CAnonical Time-series CHaracteristics. The package is an efficient implementation that calculates time-series features coded in C.

## Installation

You can install the stable version of `Rcatch22`

from CRAN using the following:

`install.packages("Rcatch22")`

You can install the development version of `Rcatch22`

from GitHub using the following:

`devtools::install_github("hendersontrent/Rcatch22")`

## Wiki

Please open the included vignette within an R environment or visit the detailed `Rcatch22`

Wiki for information and tutorials.

With features coded in C, `Rcatch22`

is highly computationally efficient, scaling nearly linearly with time-series size. Computation time in seconds for a range of time series lengths is presented below.

## catch24

An option to include the mean and standard deviation as features in addition to `catch22`

is available through setting the `catch24`

argument to `TRUE`

:

`features <- catch22_all(x, catch24 = TRUE)`

## Citation

A DOI is provided at the top of this README. Alternatively, the package can be cited using the following:

```
To cite package 'Rcatch22' in publications use:
Trent Henderson (2021). Rcatch22: Calculation of 22 CAnonical
Time-Series CHaracteristics. R package version 0.1.13.
A BibTeX entry for LaTeX users is
@Manual{,
title = {Rcatch22: Calculation of 22 CAnonical Time-Series CHaracteristics},
author = {Trent Henderson},
year = {2021},
note = {R package version 0.1.13},
}
```

Please also cite the original *catch22* paper: