load_map {cuperdec} | R Documentation |
Load metadata table
Description
Loads a metadata table and reformats it for downstream analysis. This needs to include at minimum two columns: sample name, and sample source.
Usage
load_map(x, sample_col, source_col)
Arguments
x |
Path to a TSV file or tidy dataframe (e.g. tibble) with a column containing sample names and other grouping metadata columns. |
sample_col |
A column name specifying which column should be used to specify sample names. |
source_col |
A column name specifying which group or the source the sample is from. |
Details
The two columns required need to include the following information:
Sample name - a unique identifier for each sample
Sample source - a grouping ID indicating what 'source' the sample is from This is used for plotting to separate comparative 'sources' to your own samples.
Value
A tibble, formatted for use in downstream cuperdec functions.
Examples
data(cuperdec_metadata_ex)
metadata_table <- load_map(cuperdec_metadata_ex,
sample_col = "#SampleID",
source_col = "Env"
)