Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.1 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.1 KB

orbs

R-CMD-check Lifecycle: experimental Codecov test coverage

The goal of orbs is to handle cyclical/harmonic and rhythmic data. The major functionality is to evaluate phasic data using harmonic regressions. It provides support for the basic regression directly, but also implements a tidymodels syntax to be called through parsnip.

Currently, this software has been written in a previous package that was published on CRAN called card. However, due to a series of expansions in the software and design choices, that package is being split into two parts. The first deals with cardiovascular data, and this package will instead focus on the rhythm analyses. There will be due notice on the software deprecation.

On names

Naming things is hard, and this name is partially an acronym (Cyclical and Rhythm Based Statistics - yes, the C looks like an O). It also stems from the Latin word orbita which means a “wheel track, beaten path, rut, course” or from the similar word horbi which means “turning thing”. It also phonetically resembles the symbol ouroboros, the snake that bites its own tail.

Installation

Once it is available, you can install the released version of orbs from CRAN with:

#install.packages("orbs")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("asshah4/orbs")