hyp_to_rmd {hypeR} | R Documentation |
Export hyp object to rmarkdown
hyp_to_rmd( hyp_obj, file_path, title = "Workflow Report", subtitle = "", author = "", header = "Results", versioning = TRUE, show_dots = TRUE, show_emaps = TRUE, show_hmaps = FALSE, show_tables = TRUE, hyp_dots_args = list(top = 15, val = "fdr"), hyp_emap_args = list(top = 25, val = "fdr", similarity_metric = "jaccard_similarity", similarity_cutoff = 0.2), hyp_hmap_args = list(top = 25, val = "fdr"), custom_rmd_config = NULL, custom_pre_content = NULL, custom_post_content = NULL, session_info = FALSE )
hyp_obj |
A hyp object, multihyp object, or list of multihyp objects |
file_path |
A file path |
title |
Title of markdown report |
subtitle |
Subtitle of markdown report |
author |
Authors of markdown report |
header |
Header name of tabset section |
versioning |
Add versioning information |
show_dots |
Option to show dots plots in tabs |
show_emaps |
Option to show enrichment maps in tabs |
show_hmaps |
Option to show hiearchy maps in tabs |
show_tables |
Option to show table in tabs |
hyp_dots_args |
A list of keyword arguments passed to hyp_dots |
hyp_emap_args |
A list of keyword arguments passed to hyp_emap |
hyp_hmap_args |
A list of keyword arguments passed to hyp_hmap |
custom_rmd_config |
Replace configuration section of markdown report |
custom_pre_content |
Insert custom content before tabset section |
custom_post_content |
Insert custom content after tabset section |
session_info |
Use true to include session info |