rmd: Generate an Rmd table entry from a cell object

View source: R/render-rmd.R

rmdR Documentation

Generate an Rmd table entry from a cell object

Description

Given a cell object generate the corresponding piece of an Rmd table

Usage

rmd(object, key = FALSE, ...)

## Default S3 method:
rmd(object, key = FALSE, ...)

## S3 method for class 'cell'
rmd(object, key = FALSE, ...)

## S3 method for class 'cell_n'
rmd(object, key = FALSE, ...)

## S3 method for class 'tangram'
rmd(object, key = NULL, append = FALSE, pad = 10, ...)

Arguments

object

The cell_fstat for indexing

key

A filename to write key values into. Can be false if no key file is desired.

...

additional arguments to renderer. Unused

append

logical; Should the key file be appended too, or overwritten

pad

numeric; Minimum width of columns can be a single or vector of numerics.

Value

A string representation of the table

Examples

 rmd(tangram(drug ~ bili, pbc))

spgarbet/tg documentation built on Feb. 21, 2023, 3:35 a.m.