mp_extract_dist {MicrobiotaProcess}R Documentation

extract the dist object from MPSE or tbl_mpse object

Description

extract the dist object from MPSE or tbl_mpse object

Usage

mp_extract_dist(x, distmethod, env.flag = FALSE, .group = NULL)

## S4 method for signature 'MPSE'
mp_extract_dist(x, distmethod, env.flag = FALSE, .group = NULL)

## S4 method for signature 'tbl_mpse'
mp_extract_dist(x, distmethod, env.flag = FALSE, .group = NULL)

## S4 method for signature 'grouped_df_mpse'
mp_extract_dist(x, distmethod, env.flag = FALSE, .group = NULL)

Arguments

x

MPSE object or tbl_mpse object

distmethod

character the method of calculated distance.

env.flag

logical whether extract the distance of samples calculated based on continuous environment factors, default is FALSE.

.group

the column name of sample information, default is NULL, when it is provided, a tibble that can be visualized via ggplot2 will return.

Value

dist object or tbl_df object when .group is provided.


[Package MicrobiotaProcess version 1.6.6 Index]