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

Learn implied attributes in pepr

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

Problem/Goal

The example below demonstrates how and why to use implied attributes functionality to save your time and effort in case multiple sample attributes need to be defined for many samples and they follow certain patterns. Please consider the example below for reference:

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

Solution

Noticeably, the samples with attributes human and mouse (in the organism column) follow two distinct patterns here. They have additional attributes in attributes genome and genome_size in the sample_table.csv file. Consequently you can use implied attributes to add those attributes to the sample annotations (set global, species-level attributes at the project level instead of duplicating that information for every sample that belongs to a species). The way how this process is carried out is indicated explicitly in the project_config.yaml file (presented below).

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

Consequently, you can design an implied_attributes multi-level key-value section in the project_config.yaml file. Note that the keys must match the column names and attributes in the sample_annotations.csv file.

Let's introduce a few modifications to the original sample_table.csv file to use the implied_attributes section of the config. Simply skip the attributes that will be implied and let the pepr do the work for you.

sampleAnnotation = system.file(
  "extdata",
  paste0("example_peps-", branch),
  "example_implied",
  "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_implied",
"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 two last columns 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.