
GAMBLR.data
Install
Most of the times, you would not need to install GAMBLR.data as a stand-alone package. GAMBLR.data is included as dependency and will be auto-installed for you with GAMBLR.open or GAMBLR from the GAMBLR-verse. However, if you do need to install this package separately, we recommend installing the package directly from GitHub (requires devtools
dependency).
::install_github(
devtools"morinlab/GAMBLR.data",
repos = BiocManager::repositories()
)
- 1
- Install GAMBLR.data directly from GitHub along with all bundled data.
Quickstart
The quick and easy way to get started is to make sure the devtools
dependency is installed, then install the GAMBLR.data and list the bundled objects to confirm successful setup:
# Verify devtools is installed
if (!require("devtools")) install.packages("devtools")
# Install GAMBLR.data
::install_github(
devtools"morinlab/GAMBLR.data",
repos = BiocManager::repositories()
)
# Confirm successful setup
library(GAMBLR.data) # load package
ls("package:GAMBLR.data") # view all supplied objects
Installation for developers
The easiest way to obtain and contribute to GAMBLR.data is to do this via cloning the repository
cd
git clone git@github.com:morinlab/GAMBLR.data.git
In your R editor of choice (which is hopefully VS Code), set your working directory to the directory you just cloned the repo into.
setwd("~/GAMBLR.data")
Install the package in R by running the following command (requires the devtools
package):
::install() devtools
After applying your modifications to the code, use the following command to quickly test your changes without directly installing the package (requires the devtools
dependency):
::load_all() devtools
GAMBLR.data 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.