K2dashboard: Generate interactive dashboard of K2 Taxonomer results

View source: R/K2dashboard.R

K2dashboardR Documentation

Generate interactive dashboard of K2 Taxonomer results

Description

This function will generate an interactive dashboard of the annotated K=2 clustering results in a specified directory.

Usage

K2dashboard(
  K2res,
  analysis_name = "K2Taxonomer",
  about = TRUE,
  output_dir = "."
)

Arguments

K2res

Object of class K2.

analysis_name

Character string of the name of analysis to write files and generate title of report.

about

Logical. Whether to create an 'about' tab in the dashboard.

output_dir

Base directory to put report.

Value

Nothing. Writes files to a specified directory.

References

\insertRef

reed_2020K2Taxonomer

Examples


## Read in K2 Taxonomer results
data(K2res)

## Generate interactive dashboard
K2dashboard(K2res, output_dir=tempdir())


montilab/K2Taxonomer documentation built on Jan. 25, 2024, 4:29 p.m.