vreuter/pepr

The pepr package: Portable Encapsulated Projects in R

pepr is an R package for reading Portable Encapsulated Projects, or PEPs, in R. pepr is currently in alpha and should not be used production projects. It is made available for conceptual and testing purposes only.

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

Links to complete documentation:

• Complete documentation and API for the pepr R package is at code.databio.org/pepr.
• Reference documentation for standard PEP format at pepkit.github.io.
• Example PEPs for testing pepr are in the example_peps repository or in other examples of PEPs.

Install

devtools::install_github("pepkit/pepr")

Quick start:

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

samples(p)
config(p)