Skip to content

Commit e8d7be3

Browse files
authored
Merge pull request #212 from philerooski/phil-patch-209
Additional installation instructions
2 parents af53706 + c8ff0bc commit e8d7be3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ mhealthtools processes raw data from various mobile and wearable sensors — suc
88

99
### Installing
1010

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

1313
```
1414
devtools::install_github("Sage-Bionetworks/mhealthtools")
1515
```
1616

1717
Install the package with the vignettes:
1818
```
19-
devtools::install_github("Sage-Bionetworks/mhealthtools", build_vignettes = TRUE)
19+
devtools::install_github("Sage-Bionetworks/mhealthtools", build_vignettes = TRUE, dependencies = TRUE)
2020
```
2121

2222
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.
2323

2424
### Known Installation Issues
25-
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:
25+
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:
2626

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

39+
If not using a Debian-based system, please [check for equivalent dependencies in your distro's package repository](https://pkgs.org/).
40+
3941
See the `seewave` [installation page](http://rug.mnhn.fr/seewave/inst.html) for more info.
4042

4143
### Usage

0 commit comments

Comments
 (0)