| Type: | Package |
| Title: | Calculation of 22 Canonical Time-Series Characteristics |
| Version: | 0.2.3 |
| Date: | 2024-09-30 |
| Maintainer: | Trent Henderson <then6675@uni.sydney.edu.au> |
| Description: | Calculate 22 summary statistics coded in C on time-series vectors to enable pattern detection, classification, and regression applications in the feature space as proposed by <doi:10.1007/s10618-019-00647-x>. |
| BugReports: | https://github.com/hendersontrent/Rcatch22/issues/ |
| License: | GPL-3 |
| Encoding: | UTF-8 |
| LazyData: | true |
| Depends: | R (≥ 3.5.0) |
| Imports: | rlang, stats, Rcpp (≥ 0.12.15) |
| LinkingTo: | Rcpp |
| Suggests: | knitr, markdown, rmarkdown, testthat (≥ 3.0.0) |
| RoxygenNote: | 7.1.1 |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | yes |
| Packaged: | 2024-09-30 21:50:08 UTC; trenthenderson |
| Author: | Trent Henderson [cre, aut], Carl Lubba [ctb] |
| Repository: | CRAN |
| Date/Publication: | 2024-10-02 22:30:03 UTC |
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
CO_Embed2_Dist_tau_d_expfit_meandiff(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- CO_Embed2_Dist_tau_d_expfit_meandiff(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
CO_FirstMin_ac(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- CO_FirstMin_ac(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
CO_HistogramAMI_even_2_5(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- CO_HistogramAMI_even_2_5(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
CO_f1ecac(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- CO_f1ecac(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
CO_trev_1_num(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- CO_trev_1_num(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
DN_HistogramMode_10(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- DN_HistogramMode_10(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
DN_HistogramMode_5(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- DN_HistogramMode_5(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
DN_Mean(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Trent Henderson
Examples
x <- stats::rnorm(100)
outs <- DN_Mean(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
DN_OutlierInclude_n_001_mdrmd(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- DN_OutlierInclude_n_001_mdrmd(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
DN_OutlierInclude_p_001_mdrmd(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- DN_OutlierInclude_p_001_mdrmd(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
DN_Spread_Std(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Trent Henderson
Examples
x <- stats::rnorm(100)
outs <- DN_Spread_Std(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
FC_LocalSimple_mean1_tauresrat(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- FC_LocalSimple_mean1_tauresrat(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
FC_LocalSimple_mean3_stderr(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- FC_LocalSimple_mean3_stderr(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
IN_AutoMutualInfoStats_40_gaussian_fmmi(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- IN_AutoMutualInfoStats_40_gaussian_fmmi(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
MD_hrv_classic_pnn40(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- MD_hrv_classic_pnn40(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
PD_PeriodicityWang_th0_01(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- PD_PeriodicityWang_th0_01(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SB_BinaryStats_diff_longstretch0(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SB_BinaryStats_diff_longstretch0(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SB_BinaryStats_mean_longstretch1(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SB_BinaryStats_mean_longstretch1(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SB_MotifThree_quantile_hh(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SB_MotifThree_quantile_hh(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SB_TransitionMatrix_3ac_sumdiagcov(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SB_TransitionMatrix_3ac_sumdiagcov(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SC_FluctAnal_2_dfa_50_1_2_logi_prop_r1(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SC_FluctAnal_2_dfa_50_1_2_logi_prop_r1(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SC_FluctAnal_2_rsrangefit_50_1_logi_prop_r1(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SC_FluctAnal_2_rsrangefit_50_1_logi_prop_r1(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SP_Summaries_welch_rect_area_5_1(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SP_Summaries_welch_rect_area_5_1(x)
Function to calculate a statistical feature
Description
Function to calculate a statistical feature
Usage
SP_Summaries_welch_rect_centroid(x)
Arguments
x |
a numerical time-series input vector |
Value
scalar value that denotes the calculated time-series statistic
Author(s)
Carl H. Lubba
Examples
x <- stats::rnorm(100)
outs <- SP_Summaries_welch_rect_centroid(x)
Automatically run every time-series feature calculation included in the catch22 set
Description
Automatically run every time-series feature calculation included in the catch22 set
Usage
catch22_all(data, catch24 = FALSE)
Arguments
data |
a numerical time-series input vector |
catch24 |
a Boolean of whether to include mean and standard deviation as features |
Value
object of class DataFrame that contains the summary statistics for each feature
Author(s)
Trent Henderson & Carl H. Lubba
Examples
data <- stats::rnorm(100)
outs <- catch22_all(data)
All features available in Rcatch22 in tidy format
Description
The variables include:
Usage
feature_list
Format
A vector with 1 variable:
- feature
Name of the feature