ghinstall: ghinstall

In mmstat4: Access to Teaching Materials from a ZIP File or GitHub

ghinstall

Description

If the user agrees, it installs additional software necessary for running a script. Currently, only type=="py" for Python scripts and ⁠type=="R"`` for R scripts are supported. When a repository is downloaded, ⁠ghinstall⁠is called once. If the user calls⁠ghinstall⁠for an update, the parameter⁠force=TRUE' must be set.

Usage

ghinstall(type = c("py", "R"), force = FALSE)

Arguments

type	character: programm type (default: py)
force	logical: should the installation really done (default: 'NA)

Details

R

mmstat4 init_R.R is opened if present in the active repository.

py

mmstat4 internally utilizes a virtual environment named mmstat4.xxxx, where xxxx⁠, varies depending on the repository. When ⁠ghinstall⁠is invoked, it verifies the existence of the virtual environment⁠mmstat4.xxxx⁠. If it does not exist, the environment is created, and ⁠init_py.R' is opened if present in the active repository.

Value

NULL if type is not found, otherwise type

Examples

# to delete the virtual environment use
# reticulate::virtualenv_remove('mmstat4')
if (interactive()) ghinstall()

mmstat4 documentation built on May 29, 2024, 11:15 a.m.