Project

This is a helper that creates the project with empty samples and config slots

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.
Described in Sheffield et al. (2021) <doi:10.1093/gigascience/giab077>.

Nathan Sheffield

pepr

Reading Portable Encapsulated Projects

Michal Stolarczyk

Project function

<dl><dt>file</dt>
<dd>a string specifying a path to a project configuration YAML file</dd>
<dt>amendments</dt>
<dd>a string with the amendments names to be activated</dd>
<dt>sampleTableIndex</dt>
<dd>a string indicating the sample attribute that is used
to index the sample table</dd>
<dt>subSampleTableIndex</dt>
<dd>a string indicating the sample attribute that is used
to index the sample table</dd></dl>

Arguments

The constructor of a class representing a Portable Encapsulated Project — Project

<dl>

<dt>file</dt>
<dd>a string specifying a path to a project configuration YAML file</dd>


<dt>amendments</dt>
<dd>a string with the amendments names to be activated</dd>


<dt>sampleTableIndex</dt>
<dd>a string indicating the sample attribute that is used
to index the sample table</dd>


<dt>subSampleTableIndex</dt>
<dd>a string indicating the sample attribute that is used
to index the sample table</dd>

</dl>

Project: The constructor of a class representing a Portable Encapsulated Project

Description

Usage

Value

Arguments

Examples