GAMBLR.viz

Collection of functions for visualzation of genomic data
Why use GAMBLR.viz? How to install? How to use? Release notes GitHub

Install

We recommend installing the package directly from GitHub (requires devtools dependency).

devtools::install_github(
    "morinlab/GAMBLR.viz",
    repos = BiocManager::repositories()
)

Quickstart

The quick and easy way to get started is to make sure the devtools dependency is installed, then install the GAMBLR.viz:

# Verify devtools is installed
if (!require("devtools")) install.packages("devtools")

# Install GAMBLR.viz
devtools::install_github(
    "morinlab/GAMBLR.viz",
    repos = BiocManager::repositories()
)

Installation for developers

The easiest way to obtain and contribute to GAMBLR.viz is to do this via cloning the repository

cd
git clone git@github.com:morinlab/GAMBLR.viz.git

In your R editor of choice (which is hopefully VS Code now), set your working directory to the place you just cloned the repo.

setwd("~/GAMBLR.viz")

Install the package in R by running the following command (requires the devtools package):

devtools::install()

After applying your modifications to the code, use the following command to quickly test your changes without directly installing the packaage (requires the devtools dependency):

devtools::load_all()

GAMBLR.viz is a free open-source package, but the Master branch is protected. We welcome contributions (pull request, bug report, feature request, PR review) from all levels of users. All commits must be submitted via pull request on a branch. Please refer to the GitHub documentation for details on how to do pull request.

Back to top