From 91a5834dd701211f929fd25419dc34561ce3b4e7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 14 Feb 2025 09:15:20 +0100 Subject: Initialize dev docs --- docs/dev/reference/summary_listing.html | 119 ++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 docs/dev/reference/summary_listing.html (limited to 'docs/dev/reference/summary_listing.html') diff --git a/docs/dev/reference/summary_listing.html b/docs/dev/reference/summary_listing.html new file mode 100644 index 00000000..6e1bad37 --- /dev/null +++ b/docs/dev/reference/summary_listing.html @@ -0,0 +1,119 @@ + +Display the output of a summary function according to the output format — summary_listing • mkin + Skip to contents + + +
+
+
+ +

Display the output of a summary function according to the output format

+ Source: R/summary_listing.R +
summary_listing.Rd
+
+ +
+

This function is intended for use in a R markdown code chunk with the chunk +option results = "asis".

+
+ +
+

Usage

+ 
summary_listing(object, caption = NULL, label = NULL, clearpage = TRUE)
+
+tex_listing(object, caption = NULL, label = NULL, clearpage = TRUE)
+
+html_listing(object, caption = NULL)
+
+ +
+

Arguments

+ + +
object
+

The object for which the summary is to be listed

+ + +
caption
+

An optional caption

+ + +
label
+

An optional label, ignored in html output

+ + +
clearpage
+

Should a new page be started after the listing? Ignored in html output

+ +
+ +
+ + +
+ + + + + + + -- cgit v1.2.1