The goal of bcbioR is to create guidelines for NGS data interpretation based on the experience of the Harvard Chan Bioinformatics Core and everybody who contributes to this package.
Installation
You can install the development version of bcbioR from GitHub with:
# install.packages("devtools")
devtools::install_github("bcbio/bcbioR")
devtools::install_github("bcbio/bcbioR",ref = "devel")Quick start
Use this code to generate a standard project name for all of your folders. This code will not create any folders or files.
library(bcbioR)
## basic example code
# will help you to build a folder name following HCBC naming rules
bcbio_set_project()Set base project
use setwd() to set your current directory to the place where you want to work. The bcbioR functions will automatically write to whatever directory you have set.
setwd("/path/to/analysis/folder")The following code will pop up a Rmd template will populate that folder with HCBC data structure guidelines
bcbio_templates(type="base", outpath="/path/to/analysis/folder")Set RNAseq report folder
This code will populate the folder with HCBC data structure guidelines and Rmd code: You do not need to create a reports folder prior to running this code. This will create and populate the reports folder.
bcbio_templates(type="rnaseq", outpath="/path/to/analysis/folder/reports")Discover more…
Go to the vignette to know more vignette("bcbioR_quick_start",package="bcbioR")
How to Contribute
Modify the code
- Clone the repository
- Make sure you are in the
develbranch - Create a new branch
git checkout -b feature1 - Modify you code, add and commit
- Push to GitHub the new branch
- Create a PR from your branch to
devel - Assignt the PR to me or Alex
Some best practices when developing:
- install
devtools - Use
usethis::use_import_from("stringr","str_replace_all")to add a new function you are using in the code.