README.md

Build Status

hwglabr2

Hochwagen lab R package 2

Compilation of functions used frequently by Hochwagen lab members. This is a rewrite of the original package hwglabr (GitHub repo), designed to leverage Bioconductor's GRanges object class.

Installation

You can install the package directly from the source code on GitHub. For that you will need Hadley Wickham's devtools R package:

install.packages("devtools")

Once you have devtools you can install and load hwglabr2:

devtools::install_github("hochwagenlab/hwglabr2")
library(hwglabr2)

Documentation

See the Analysis recipes GitHub wiki page for example usage of hwglabr2 to perform some common analysis.

For function documentation, use the package GitHub repo and the documentation website built with pkgdown.

Function documentation is also accessible within R in the standard way, by typing one of the following:

help("function_name")

?function_name

License

This project is licensed under the terms of the MIT license. See LICENSE file for details.



hochwagenlab/hwglabr2 documentation built on Jan. 31, 2020, 11:05 a.m.