setStandalone: Set settings for epiviz standalone repository.

In epiviz/epivizrStandalone: Run Epiviz Interactive Genomic Data Visualization App within R

Description

The epiviz app run by function startStandalone in this package is cloned as a git repository. This function intializes the settings specifying which git repository is used. It can be either a github repository (the usual case), or local repository containing the epiviz JS app (used for testing and development).

Usage

setStandalone(
  url = "https://github.com/epiviz/epiviz.git",
  branch = "min",
  local_path = NULL,
  non_interactive = FALSE
)

Arguments

url	(character) github url to use. defaults to ("https://github.com/epiviz/epiviz.git").
branch	(character) branch on the github repository. defaults to (master).
local_path	(character) if you already have a local instance of epiviz and would like to run standalone use this.
non_interactive	(logical) don't download repo, used for testing purposes.

Value

path to the epiviz app git repository

Examples

# argument non_interactive here to avoid downloading when testing
# package. Remove non_interactive argument when you try it out.
setStandalone(url="https://github.com/epiviz/epiviz.git", branch="master", non_interactive=TRUE)

epiviz/epivizrStandalone documentation built on May 5, 2021, 4:27 a.m.