Skip to contents

Use the {downlit} package to generate a Markdown list of autolinked functions wrapped inside <details> tags.

Source: R/html.R
format_used_functions.Rd

Use the {downlit} package to generate a Markdown list of autolinked functions wrapped inside <details> tags.

Usage

format_used_functions(functions, do_cat = FALSE)

Arguments

functions

A character scalar: functions to be autolinked, e.g. scran::clusterCells().

do_cat

A logical scalar: if TRUE, cat the result to stdout.

Value

A character scalar. Invisibly if do_cat is TRUE.

Examples

format_used_functions(c("scran::clusterCells()", "Seurat::DimPlot()"), do_cat = TRUE)
#> 
#> <details>
#>   <summary class='used-functions'>Show used functions ▾</summary>
#> 
#>   <div class='used-functions-content'>
#> -   [`scran::clusterCells()`](https://rdrr.io/pkg/scran/man/clusterCells.html)
#> -   [`Seurat::DimPlot()`](https://satijalab.org/seurat/reference/DimPlot.html)
#> 
#>   </div>
#> </details>
#>