Skip to content

Commit

Permalink
Merge pull request #39 from pepkit/dev
Browse files Browse the repository at this point in the history
v0.3.2
  • Loading branch information
stolarczyk authored Jun 4, 2020
2 parents e27d8a9 + 68c3c6b commit 345cb54
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
10 changes: 7 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
Package: pepr
Type: Package
Title: Reading Portable Encapsulated Projects
Version: 0.3.1
Date: 2020-05-27
Version: 0.3.2
Date: 2020-06-03
Authors@R: c(person("Nathan", "Sheffield", email = "[email protected]",
role = c("aut", "cph")),person("Michal","Stolarczyk",email="[email protected]",role=c("aut","cre")))
Maintainer: Michal Stolarczyk <[email protected]>
Description: Reads standardized project configuration files into R.
Description: A PEP, or Portable Encapsulated Project, is a dataset that
subscribes to the PEP structure for organizing metadata. It is written using
a simple YAML + CSV format, it is your one-stop solution to metadata
management across data analysis environments. This package reads this
standardized project configuration structure into R.
Imports:
yaml,
stringr,
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# pepr 0.3.2 - 2020-06-03

## Changed

* package description

# pepr 0.3.1 - 2020-05-27

## Fixed
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@

[![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/pepr)](http://cranlogs.r-pkg.org/badges/grand-total/pepr)
[![CRAN](http://www.r-pkg.org/badges/version-last-release/pepr)](http://www.r-pkg.org/badges/version-last-release/pepr)
[![Build Status](https://travis-ci.org/pepkit/pepr.svg?branch=master)](https://travis-ci.org/pepkit/pepr)
[![Coverage Status](https://coveralls.io/repos/github/pepkit/pepr/badge.svg?branch=dev)](https://coveralls.io/github/pepkit/pepr?branch=dev&service=github)
[![PEP compatible](http://pepkit.github.io/img/PEP-compatible-green.svg)](http://pepkit.github.io)

`pepr` is not yet released, but has been submitted to CRAN and should be available for a standard installation shortly. Complete documentation and API for the `pepr` R package is at [code.databio.org/pepr](http://code.databio.org/pepr/).

# The `pepr` package: Portable Encapsulated Projects in R

`pepr` is an R package for reading [Portable Encapsulated Projects](http://pep.databio.org/en/2.0.0/), or **PEP**s, in R. If you describe your project (configuration and samples) according to this format, you can load all project metadata into R using the `pepr` package. To test `pepr`, you can try loading one of the [example PEPs](https://github.com/pepkit/example_peps).

Complete documentation and API for the `pepr` R package is at [code.databio.org/pepr](http://code.databio.org/pepr/).


## Quick start:

Install from GitHub:
Install from [CRAN](https://cran.rstudio.com/web/packages/pepr/index.html):

```R
devtools::install_github("pepkit/pepr")
install.packages("pepr")
```

Load a project and explore metadata like this:

```R
library("pepr"")
library("pepr")
cfgPath = system.file(
"extdata",
paste0("example_peps-master"),
Expand Down

0 comments on commit 345cb54

Please sign in to comment.