knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

Learn constant attributes in pepr

This vignette will show you how and why to use the constant attributes functionality of the pepr package.

Problem/Goal

The example below demonstrates how to use the constant attributes to define the samples attributes in the read_type column of the sample_table.csv file. This functionality is extremely useful when there are many samples that are characterized by identical values of certain attribute (here: value SINGLE in read_type attribute). Please consider the example below for reference:

branch = "master"
library(knitr)
sampleAnnotation = system.file(
"extdata",
paste0("example_peps-", branch),
"example_constants",
"sample_table_pre.csv",
package = "pepr"
)
sampleAnnotationDF = read.table(sampleAnnotation, sep = ",", header = T)
knitr::kable(sampleAnnotationDF, format = "html") 

Solution

As the name suggests the attributes in the specified attributes (here: read_type) can be defined as constant ones. The way how this process is carried out is indicated explicitly in the project_config.yaml file (presented below). The name of the column is determined in the constant_attributes key-value pair. Note that definition of more than one constant attribute is possible.

library(pepr)
projectConfig = system.file(
"extdata",
paste0("example_peps-", branch),
"example_constants",
"project_config.yaml",
package = "pepr"
)
.printNestedList(yaml::read_yaml(projectConfig))

Let's introduce a few modifications to the original sample_table.csv file to use the constant_attributes section of the config. Simply skip the attributes that are set constant and let the pepr do the work for you.

sampleAnnotation = system.file(
  "extdata",
  paste0("example_peps-", branch),
  "example_constants",
  "sample_table.csv",
  package = "pepr"
  )
  sampleAnnotationDF = read.table(sampleAnnotation, sep = ",", header = T)
  kable(sampleAnnotationDF, format = "html") 

Code

Load pepr and read in the project metadata by specifying the path to the project_config.yaml:

library(pepr)
projectConfig = system.file(
"extdata",
paste0("example_peps-", branch),
"example_constants",
"project_config.yaml",
package = "pepr"
)
p = Project(projectConfig)

And inspect it:

samples(p)

As you can see, the resulting samples are annotated the same way as if they were read from the original annotations file with attributes in the last column manually determined.

What is more, the p object consists of all the information from the project config file (project_config.yaml). Run the following line to explore it:

config(p)


pepkit/pepr documentation built on Jan. 11, 2020, 11:06 a.m.