validate_MicrobiomeR_format: Validate MicrobiomeR Format

In vallenderlab/MicrobiomeR: Analyze Microbiome Data

Description

This function validates that Taxmap objects are in a valid format MicrobiomeR format.

Usage

validate_MicrobiomeR_format(obj, validated = FALSE, valid_formats,
  force_format = FALSE, min_or_max = base::max, ...)

Arguments

obj	A Taxmap object.
validated	This parameter provides a way to override validation steps. Use carefully. Default: FALSE
valid_formats	A vector of formats that are used for validation.
force_format	A logical denoting if the selected format is to be forced. Default: FALSE
min_or_max	A base function (min or max) that determines which format is to be forced. This is particularly useful if you provide multiple valid_formats. Min will choose the lowest level format, while max will choose the highest level format. Default: base::max
...	An optional list of parameters to use in as_MicrobiomeR_format.

Details

This function can provide a way to check if a taxmap object has undergone a MicrobiomeR Style Workflow.

Value

If the object is validated, a Taxmap object.

See Also

which_format, as_MicrobiomeR_format

Other Validation: is_analyzed_format, is_basic_format, is_phyloseq_format, is_raw_format, order_metacoder_data, which_format

vallenderlab/MicrobiomeR documentation built on Aug. 30, 2019, 11:24 p.m.