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

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

statistics

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/smac-group/classimu
• Owner: SMAC-Group
• Created: 2018-01-15T17:10:12.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-03T19:05:10.000Z (about 8 years ago)
• Last Synced: 2025-06-04T01:05:49.735Z (about 1 year ago)
• Topics: statistics
• Language: R
• Size: 127 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

          
---

output: github_document

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

)

library(classimu)

```

[![Travis-CI Build Status](https://travis-ci.org/SMAC-Group/classimu.svg?branch=master)](https://travis-ci.org/SMAC-Group/classimu)

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

[![Licence](https://img.shields.io/badge/licence-CC BY--NC--SA 4.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)

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

[![CRAN](http://www.r-pkg.org/badges/version/classimu)](https://cran.r-project.org/package=classimu)

[![packageversion](https://img.shields.io/badge/Package%20version-0.1.0-orange.svg?style=flat-square)](commits/develop)

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

# `classimu` Overview 

Classification IMU (`classimu`) R package estimates parameters from multiple replicates coming from an IMU error signal, apply the near-stationarity test and select the nost approriate model 

* Simulation of time series simulations from SARIMA models and various state-space models that can be expressed as latent time series processes.

* Visualize time series data with user specifications.

* Visualize latent time series processes.

To see what `classimu` is capable of, please refer to the "Vignettes" tabs above.

## Install Instructions

To install the `classimu` package, there is currently one option: [GitHub](https://github.com/SMAC-Group/classimu/).

### Installing the package through GitHub

For users who are interested in having the latest developments, this option is ideal. Though, more dependancies are required to run a stable version of the package. Most importantly, users **must** have a compiler installed on their machine that is compatible with R (e.g. Clang).

*The setup to obtain the development version of `classimu` is platform dependent.*

### Requirements and Dependencies

**OS X**

Some users report the need to use X11 to suppress shared library errors. To install X11, visit [xquartz.org](http://www.xquartz.org/).

**Linux**

Both curl and libxml are required.

For **Debian** systems, enter the following in terminal:

```{r, eval = F, engine='bash'}

sudo apt-get install curl libcurl3 libcurl3-dev libxml2 libxml2-dev

```

For **RHEL** systems, enter the following in terminal:

```{r, eval = F, engine='bash'}

sudo yum install curl curl-devel libxml2 libxml2-dev

```

**All Systems**

The following R packages are also required. If you have made it this far, run the following code in an R session and you will be ready to use the devlopment version of `classimu`.

```{r, eval = F}

# Install dependencies

install.packages(c("RcppArmadillo","devtools","knitr","rmarkdown"))

# Install the package from GitHub without Vignettes/User Guides

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

# Install the package with Vignettes/User Guides 

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

```