hyp_to_rmd {hypeR} | R Documentation

## Export hyp object to rmarkdown

### Description

Export hyp object to rmarkdown

### Usage

    hyp_to_rmd(hyp_obj, file_path, title = "hypeR Enrichment Report",
      subtitle = "", author = "", header = "Enrichment",
      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)

### Arguments

`hyp_obj` | A hyp object, multihyp object, or list of multihyp objects
`file_path` | Output file path
`title` | Title of markdown report
`subtitle` | Subtitle of markdown report
`author` | Authors of markdown report
`header` | Header name of tabset section
`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

### Value

None

[Package hypeR version 1.3.0 Index]