Complete documentatation

pepr is an R package for reading Portable Encapsulated Projects. Portable Encapsulated Projects (PEP) are sample-heavy projects that subscribe to the standard PEP project definition. An example project formatted in this way is in the microtest repository. If you describe your project (configuration and samples) according to this format, you can load all project metadata into R using the pepr package. These projects can also be used for any PEP-compatible pipeline (see this list of compatible pipelines).

pepr is currently in alpha mode and should not be used production projects. It is made available for conceptual and testing purposes only.

Install

devtools::install_github("pepkit/pepr")

Quick start:

library('pepr')
p = Project(file = "~/code/microtest/config/microtest_config.yaml")

samples(p)
config(p)

p@config
p@samples

Documentation

Complete documentation and vignettes can be found at http://code.databio.org/pepr/.