Skip to content

Commit

Permalink
Merge pull request #212 from philerooski/phil-patch-209
Browse files Browse the repository at this point in the history
Additional installation instructions
  • Loading branch information
philerooski authored Feb 27, 2020
2 parents af53706 + c8ff0bc commit e8d7be3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ mhealthtools processes raw data from various mobile and wearable sensors — suc

### Installing

Install the `mhealthtools` package using `devtools`:
Install the `mhealthtools` package using [`devtools`](https://cran.r-project.org/web/packages/devtools/index.html):

```
devtools::install_github("Sage-Bionetworks/mhealthtools")
```

Install the package with the vignettes:
```
devtools::install_github("Sage-Bionetworks/mhealthtools", build_vignettes = TRUE)
devtools::install_github("Sage-Bionetworks/mhealthtools", build_vignettes = TRUE, dependencies = TRUE)
```

Alternatively, you can use [this Docker image](https://cloud.docker.com/repository/docker/philsnyder/mhealthtools) — based on `rocker/tidyverse:latest` — which comes with `mhealthtools` preinstalled.

### Known Installation Issues
A common issue on Linux systems when installing the `seewave` dependency is to be missing the system dependencies `libfftw3` and ` libsndfile1`. In a shell, run:
A common issue on Debian-based systems when installing the `seewave` dependency is to be missing the system dependencies `libfftw3` and ` libsndfile1`. In a shell, run:

```
$ apt install libfftw3-3 libfftw3-dev libsndfile1 libsndfile1-dev
Expand All @@ -36,6 +36,8 @@ If you are still having issues installing `seewave`, it may be necessary to also
$ apt install r-cran-rgl
```

If not using a Debian-based system, please [check for equivalent dependencies in your distro's package repository](https://pkgs.org/).

See the `seewave` [installation page](http://rug.mnhn.fr/seewave/inst.html) for more info.

### Usage
Expand Down

0 comments on commit e8d7be3

Please sign in to comment.