-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
53 lines (39 loc) · 3.12 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
---
output: github_document
bibliography: biblio.bib
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{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)
```
[](https://github.com/SMAC-Group/avar/actions/workflows/R-CMD-check.yaml)
[](https://www.repostatus.org/#active/)
[](https://opensource.org/licenses/AGPL-3.0)
[](https://cran.r-project.org/)
[](https://www.r-pkg.org/pkg/avar)
[](https://www.r-pkg.org/pkg/avar)
[)`-yellowgreen.svg)](https://github.com/SMAC-Group/avar)
# Welcome to the `avar` package <a href="https://smac-group.com/"><img src="man/figures/logo.png" align="right" style="width: 16%; height: 16%"/></a>
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