ftExtra (version 0.6.4)

colformat_md: Format character columns as markdown text

Description

Format character columns as markdown text

Usage

colformat_md(
  x,
  j = where(is.character),
  part = c("body", "header", "all"),
  auto_color_link = "blue",
  md_extensions = NULL,
  pandoc_args = NULL,
  metadata = rmarkdown::metadata,
  replace_na = "",
  .from = "markdown+autolink_bare_uris-raw_html-raw_attribute",
  .footnote_options = footnote_options(),
  .sep = "\n\n"
)

Arguments

x

A flextable object

j

Columns to be treated as markdown texts. Selection can be done by the semantics of dplyr::select().

part

One of "body", "header", and "all". If "all", formatting proceeds in the order of "header" and "body".

auto_color_link

A color of the link texts.

md_extensions

Pandoc's extensions. Although it is prefixed with "md", extensions for any formats specified to .from can be used. See https://www.pandoc.org/MANUAL.html#extensions for details.

pandoc_args

Additional command line options to pass to pandoc

metadata

A list of metadata, typically the parsed result of the YAML front matter (default: rmarkdown::metadata). This value is used iff the .from argument specifies the input format that supports the YAML metadata blocks.

replace_na

A value to replace NA (default = "").

.from

Pandoc's --from argument (default: 'markdown+autolink_bare_uris').

.footnote_options

Options for footnotes generated by footnote_options().

.sep

A separator of paragraphs (default: "\n\n")

Examples

if (rmarkdown::pandoc_available("2.0.6")) {
  d <- data.frame(
    x = c("**bold**", "*italic*"),
    y = c("^superscript^", "~subscript~"),
    z = c("***^ft^~Extra~** is*", "*Cool*")
  )
  colformat_md(flextable::flextable(d))
}