load_dm: Load a dissimilarity matrix for use with mctoolsr

View source: R/input_output_filter.R

load_dmR Documentation

Load a dissimilarity matrix for use with mctoolsr

Description

Load in a dissimilarity matrix and a corresponding metadata mapping file

Usage

load_dm(dm_fp, map_fp, filter_cat, filter_vals, keep_vals)

Arguments

dm_fp

Dissimilarity matrix filepath (tab-delimited text).

map_fp

Metadata mapping filepath.

filter_cat

[OPTIONAL] The map_fp header string for the factor you would like to use to filter samples.

filter_vals

[OPTIONAL] The values within the filter category (vector or single value) you would like to use to remove samples from the imported data.

keep_vals

[OPTIONAL] Alternatively, keep only samples represented by these values.

Value

A list variable with (1) the loaded dissimilarity matrix, and (2) the loaded mapping file.

Examples

## Not run: 
load_dm("filepath_to_dissim_matrix.txt", "filepath_to_mapping_file.txt",
  "sample_type", filter_vals = "blank")

## End(Not run)

leffj/mctoolsr documentation built on Aug. 5, 2022, 1:27 a.m.