File: md_table.Rd

package info (click to toggle)
r-cran-simplermarkdown 0.0.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 392 kB
  • sloc: makefile: 2
file content (27 lines) | stat: -rw-r--r-- 759 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/md_table.R
\name{md_table}
\alias{md_table}
\title{Generate a markdown table from a data.frame}
\usage{
md_table(tab, caption, as_character = FALSE, ...)
}
\arguments{
\item{tab}{a data frame}

\item{caption}{text of the caption. When omitted no caption is added to the
table.}

\item{as_character}{return the table as a character vector. If \code{FALSE}
the table will be written to the standard output.}

\item{...}{unused.}
}
\value{
Then \code{as_character = FALSE} a character vector with the markdown
containing the table is returned.  Otherwise,
nothing is returned; the markdown is then written to the console.
}
\description{
Generate a markdown table from a data.frame
}