install_analysis_suite: Download/install AnalysisSuite codebase

Description Usage Arguments Value Easy install Developer install See Also

View source: R/install.R

Description

This will download from github (or link an existing download) to a standard location. See easy and developer install sections for recomended use cases.

Usage

1
install_analysis_suite(path = NULL, ref = "master", force = FALSE)

Arguments

path

Optional non-standard path that will be symlinked to standard location (see Developer install)

ref

Github reference (defaults to 'master')

force

Whether to overwrite an existing symlink (or directory) when using the Developer install mode to symlink an existing path.

Value

full path to AnalysisSuite root directory (invisibly)

Easy install

With default parameters, this function will download the current master of AnalysisSuite and install to a standard location. This is the easy install form recommended for a typical end user.

Developer install

The alternative form will make a symbolic link from an existing download / git checkout of AnalysisSuite to a path within the nat.as package. This is the recommendation when you update AnalysisSuite frequently or are hacking on the main AnalysisSuite codebase (when you will also be interested in the reload_analysis_suite() function.)

See Also

reload_analysis_suite


jefferis/nat.as documentation built on May 19, 2019, 3:06 a.m.