gluedown

gluedown-package

The <code>gluedown</code> package helps transition from R's powerful
vectors to formatted markdown text. The functions use <code><a href="https://glue.tidyverse.org/reference/glue.html">glue::glue()</a></code> to
wrap character vectors in valid markdown syntax. In combination with the
<code>knitr</code> package, this allows users to directly print R vectors as formatted
text for improved clarity and readability.

internal

Ease the transition between R vectors and markdown text. With
'gluedown' and 'rmarkdown', users can create traditional vectors in R,
glue those strings together with the markdown syntax, and print those
formatted vectors directly to the document. This package primarily
uses GitHub Flavored Markdown (GFM), an offshoot of the unambiguous
CommonMark specification by John MacFarlane (2019)
<https://spec.commonmark.org/>.

Kiernan Nicholls

Wrap Vectors in Markdown Formatting

gluedown-package function

The <code>md_*()</code> functions return <code>glue</code> objects, which are returned using
<code><a href="/link/cat()?package=gluedown&version=1.0.9" data-mini-rdoc="gluedown::cat()">cat()</a></code> by default. This allows users to both manipulate the formatted
strings as they would with any character vector and still present the
string to the user when an <code>knitr</code> chunk option is set to return code
results <code>'asis'</code>.

Glue wrappers

The <code>md_table()</code> and <code>md_convert()</code> functions wrap around <code><a href="/link/knitr%3A%3Akable()?package=gluedown&version=1.0.9" data-mini-rdoc="gluedown::knitr::kable()">knitr::kable()</a></code>
and <code>markdown::markdownToHTML()</code> respectively. The later allows users to
convert <code>md_*()</code> outputs to HTML fragments.

Other wrappers

Maintainer: Kiernan Nicholls <a href="/link/k5cents%40gmail.com?package=gluedown&version=1.0.9" data-mini-rdoc="gluedown::k5cents@gmail.com">k5cents@gmail.com</a> (<a href="https://orcid.org/0000-0002-9229-7897">ORCID</a>) [copyright holder]

Author

The <code>gluedown</code> package helps transition from R's powerful
vectors to formatted markdown text. The functions use <code><a href='https://glue.tidyverse.org/reference/glue.html'>glue::glue()</a></code> to
wrap character vectors in valid markdown syntax. In combination with the
<code>knitr</code> package, this allows users to directly print R vectors as formatted
text for improved clarity and readability.

gluedown: A package to format character vectors with markdown. — gluedown-package

The <code>md_*()</code> functions return <code>glue</code> objects, which are returned using
<code><a href='https://rdrr.io/r/base/cat.html'>cat()</a></code> by default. This allows users to both manipulate the formatted
strings as they would with any character vector and still present the
string to the user when an <code>knitr</code> chunk option is set to return code
results <code>'asis'</code>.

The <code>md_table()</code> and <code>md_convert()</code> functions wrap around <code><a href='https://rdrr.io/pkg/knitr/man/kable.html'>knitr::kable()</a></code>
and <code>markdown::markdownToHTML()</code> respectively. The later allows users to
convert <code>md_*()</code> outputs to HTML fragments.

Maintainer: Kiernan Nicholls <a href='mailto:k5cents@gmail.com'>k5cents@gmail.com</a> (<a href='https://orcid.org/0000-0002-9229-7897'>ORCID</a>) [copyright holder]

gluedown-package: gluedown: A package to format character vectors with markdown.

Description

Arguments

Glue wrappers

Other wrappers

Author

See Also