https://github.com/smac-group/avar

:airplane: Computationally efficient implementation of the Allan variance.
https://github.com/smac-group/avar

allan-variance inertial-sensors statistics time-series

Last synced: about 1 year ago
JSON representation

:airplane: Computationally efficient implementation of the Allan variance.

• Host: GitHub
• URL: https://github.com/smac-group/avar
• Owner: SMAC-Group
• Created: 2018-05-03T01:33:04.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-07-11T18:20:29.000Z (almost 4 years ago)
• Last Synced: 2025-05-26T22:37:34.456Z (about 1 year ago)
• Topics: allan-variance, inertial-sensors, statistics, time-series
• Language: R
• Homepage: https://smac-group.github.io/avar/
• Size: 98.9 MB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

          
---

output: github_document

bibliography: biblio.bib

---

```{r, echo=FALSE, message=FALSE, warning=FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  dpi = 300,

  out.width = "100%",

  comment = "#>",

  fig.path = "man/figures/README-"

)

library(avar)

```

[![R-CMD-check](https://github.com/SMAC-Group/avar/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/SMAC-Group/avar/actions/workflows/R-CMD-check.yaml)

[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active/)

[![Licence](https://img.shields.io/badge/licence-AGPL--3.0-blue.svg)](https://opensource.org/licenses/AGPL-3.0)

[![minimal R version](https://img.shields.io/badge/R%3E%3D-3.4.0-6666ff.svg)](https://cran.r-project.org/)

[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/avar)](https://www.r-pkg.org/pkg/avar)

[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/avar)](https://www.r-pkg.org/pkg/avar)

[![Last-changedate](https://img.shields.io/badge/last%20change-`r gsub('-', '--', Sys.Date())`-yellowgreen.svg)](https://github.com/SMAC-Group/avar)

# Welcome to the `avar` package 

This package provides the tools necessary to compute the empirical Allan Variance (AV) and use it to estimate the parameters of (latent) time series models. The estimation of the Allan Variance is performed through the estimator proposed by @allan1966statistics and, based on this quantity, the Allan Variance Linear Regression (AVLR) approach (or Allan Variance Slope Method) is often used by engineers to retrieve the parameters of time series models which are assumed to underlie the observed signals [see for example @guerrier2016theoretical]. These estimators are implemented in this package along with the relevant plotting and summary functions.

## Install Instructions

The `avar` package is available on both CRAN and GitHub. The CRAN version is considered stable while the GitHub version is subject to modifications/updates which may lead to installation problems or broken functions. You can install the stable version of the `avar` package with:

```{r, eval=FALSE}

install.packages("avar")

```

For users who are interested in having the latest developments, the [GitHub](https://github.com/SMAC-Group/avar) version is ideal although more dependencies are required to run a stable version of the package. Most importantly, users **must** have a (C++) compiler installed on their machine that is compatible with R (e.g. Clang). Once you've made sure that you have a compatible C++ compiler installed on your computer, run the following code in an R session and you will be ready to use the devlopment version of `avar`.

```{r, eval = F}

# Install dependencies

install.packages(c("devtools"))

# Install/Update the package from GitHub

devtools::install_github("SMAC-Group/avar")

# Install the package with Vignettes/User Guides 

devtools::install_github("SMAC-Group/avar", build_vignettes = TRUE)

```

## References