Skip to content

Latest commit

 

History

History
executable file
·
101 lines (74 loc) · 3.58 KB

README.md

File metadata and controls

executable file
·
101 lines (74 loc) · 3.58 KB
Raw

bcbioR

R-CMD-check

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

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

path="/path/to/analysis/folder"
bcbio_templates(type="base", outpath=path)
bcbio_templates(type="rnaseq", outpath=path)
bcbio_templates(type="singlecell", outpath=path)

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")

Supported analyses

  • base/reports/example.Rmd:
  • rnaseq/DE/Intersections.Rmd:
  • rnaseq/DE/GSVA.Rmd:
  • rnaseq/DE/DEG.Rmd:
  • rnaseq/DE/Cross-comparison-analysis.Rmd:
  • rnaseq/QC/QC_nf-core.Rmd:
  • singlecell/Integration/norm_integration.rmd:
  • singlecell/QC/QC.rmd:
  • singlecell_delux/CellToCell/cellchat.Rmd:
  • chipseq/diffbind/diffbind.Rmd:
  • chipseq/QC/QC.Rmd:
  • spatial/cosmx/QC/QC.Rmd:
  • methylation/QC/QC.Rmd:
  • multiomics/teaseq/QC/QC.Rmd:

Discover more…

Go to the vignette to know more vignette("bcbioR_quick_start", package="bcbioR")

How to Contribute

Open an issue

  • If you find a bug
  • If you want a new feature
  • If you want to add code to the templates

Modify the code

  • Clone the repository
  • Make sure you are in the devel branch
  • 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.

Contributors

  • Lorena Pantano
  • Alex Bartlett
  • Emma Berdan
  • Heather Wick
  • James Billingsley
  • Zhu Zhuo
  • Elizabeth Partan
  • Noor Sohail
  • Meeta Mistry
  • Will Gammerdinger
  • Upen Bhattarai
  • Shannan Ho Sui