mdtable: Generate an mdtable object.

View source: R/classes.R

mdtableR Documentation

Generate an mdtable object.

Description

Bundles a data frame with its R markdown reference and caption and file name for saving on the disc.

Usage

mdtable(x, label, ref_name, caption)

Arguments

x

a data frame or tibble.

label

the final file name.

ref_name

name of the reference to the table, used mainly in markdown documents.

caption

text to be presented in the table caption.

Details

Technically, a data frame with label, ref_name and caption attributes. The mdtable inherits from data frame most of its methods. ref_name: needs to be a valid markdown/bookdown reference name. By default, spaces, slashes and underscores are silently turned into '-'. You may easily insert the read-to-use table object code chunk into your Rmarkdown document with the 'insert()' method or reference it in the text by calling 'refer()'.

Value

An object of class 'mdtable'


PiotrTymoszuk/figur documentation built on July 16, 2024, 1:15 a.m.