Installation of the GGIR R Package
Source:vignettes/chapter0_Installation.Rmd
chapter0_Installation.Rmd
Install GGIR
Install the latest released version of GGIR with its dependencies from CRAN. You can do this with one command from the R command line:
install.packages("GGIR", dependencies = TRUE)
library(GGIR)
Alternatively, you can install the latest development version, which might include additional bug fixes and functionalities. To get the development version, please use:
install.packages("remotes", dependencies = TRUE)
remotes::install_github("wadpac/GGIR", dependencies = TRUE)
library(GGIR)
Other packages you may need
Additionally, in some use-cases you will need to install one or multiple additional packages. Note that these packages are not installed by default, so please follow the instructions if:
- You want to derive Neishabouricounts (with
do.neishabouricounts = TRUE
), install the actilifecounts package withinstall.packages("actilifecounts")
- You want to process Sensewear xlsx files (with
dataFormat = "sensewear"
), install the readxl package withinstall.packages("readxl")
Installing older versions of a package
When aiming to reproduce historical analysis it is critical to install the correct package version. Below we will explain how to do this for GGIR release 2.4-0 but this should work for any release. Note that GGIR is archived on both CRAN (major releases only) and GitHub (all releases).
From CRAN archive:
require(remotes)
install_version("GGIR", version = "2.4-0", repos = "http://cran.us.r-project.org")
To see which releases are available on CRAN check out: https://cran.r-project.org/src/contrib/Archive/GGIR/.
From GitHub:
require(remotes)
install_github("wadpac/GGIR", ref = "2.4-0")
To see which releases are available on CRAN check out: https://github.com/wadpac/GGIR/releases.