Package 'rmdtools' reference manual

Title:	Tools for RMarkdown
Description:	Tools for RMarkdown
Authors:	Sebastian Kranz
Maintainer:	Sebastian Kranz <[email protected]>
License:	GPL >= 2.0
Version:	0.2.7
Built:	2026-05-07 08:20:04 UTC
Source:	https://github.com/skranz/rmdtools

Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluation

Description

Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluation

Usage

adapt.hf.blocks(
  txt,
  block.df = NULL,
  out.type = "html",
  only.types = c("if", "note"),
  ...
)
adapt.hf.blocks(
  txt,
  block.df = NULL,
  out.type = "html",
  only.types = c("if", "note"),
  ...
)

Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluation

Description

Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluation

Usage

adapt.if.blocks(
  txt,
  block.df = NULL,
  out.type = "html",
  only.types = "if",
  ...
)
adapt.if.blocks(
  txt,
  block.df = NULL,
  out.type = "html",
  only.types = "if",
  ...
)

Add code button with div to an ui

Description

Add code button with div to an ui

Usage

add.code.ui(
  ui = NULL,
  code,
  show_code,
  code.highlight = TRUE,
  print_remove_code_note = TRUE
)
add.code.ui(
  ui = NULL,
  code,
  show_code,
  code.highlight = TRUE,
  print_remove_code_note = TRUE
)

Create a Rmd chunk header line from a list of arguments

Description

Create a Rmd chunk header line from a list of arguments

Usage

args.to.chunk.header(args = list(), type = "r", label = args$label)
args.to.chunk.header(args = list(), type = "r", label = args$label)

Scan all used block and whisker parameters in an .rmd file and create a template for a list

Description

Scan all used block and whisker parameters in an .rmd file and create a template for a list

Usage

cat.rmd.params(
  file = NULL,
  text = readLines(file, warn = FALSE),
  use.blocks = TRUE,
  use.whiskers = TRUE
)
cat.rmd.params(
  file = NULL,
  text = readLines(file, warn = FALSE),
  use.blocks = TRUE,
  use.whiskers = TRUE
)

cat.whisker params

Description

cat.whisker params

Usage

cat.whisker.params(file = NULL, text = readLines(file, warn = FALSE))
cat.whisker.params(file = NULL, text = readLines(file, warn = FALSE))

Translates a chunk header to a list of its option

Description

Translates a chunk header to a list of its option

Usage

chunk.opt.string.to.list(str, keep.name = FALSE)
chunk.opt.string.to.list(str, keep.name = FALSE)

Arguments

str

the chunk header as written in the rmd file

keep.name

shall the chunk name be kept?

Main function to compile rmd to html

Description

Main function to compile rmd to html

Usage

compile.rmd(
  file = NULL,
  text = readLines(file, warn = FALSE),
  envir = list(),
  if.blocks = c("ph", "render", "ignore")[1],
  blocks = c("ph", "render", "ignore")[1],
  whiskers = c("ph", "render", "render.as.text", "ignore")[1],
  chunks = c("ph", "knit", "render", "ignore")[1],
  start.line = "<!-- START -->",
  end.line = "<!-- END -->",
  set.utf8 = TRUE,
  out.type = "html",
  fragment.only = FALSE,
  whiskers.call.list = NULL,
  blocks.call.list = NULL,
  add.info = TRUE,
  use.commonmark = FALSE
)
compile.rmd(
  file = NULL,
  text = readLines(file, warn = FALSE),
  envir = list(),
  if.blocks = c("ph", "render", "ignore")[1],
  blocks = c("ph", "render", "ignore")[1],
  whiskers = c("ph", "render", "render.as.text", "ignore")[1],
  chunks = c("ph", "knit", "render", "ignore")[1],
  start.line = "<!-- START -->",
  end.line = "<!-- END -->",
  set.utf8 = TRUE,
  out.type = "html",
  fragment.only = FALSE,
  whiskers.call.list = NULL,
  blocks.call.list = NULL,
  add.info = TRUE,
  use.commonmark = FALSE
)

Render a knitr chunk in the same way as a whisker (taking into some chunk options, like results="asis")

Description

Render a knitr chunk in the same way as a whisker (taking into some chunk options, like results="asis")

Usage

eval.chunk.like.whisker(
  code,
  call = NULL,
  options = NULL,
  env = parent.frame()
)
eval.chunk.like.whisker(
  code,
  call = NULL,
  options = NULL,
  env = parent.frame()
)

Render all knitr chunks in the same way as a whisker (taking into some chunk options, like results="asis")

Description

Render all knitr chunks in the same way as a whisker (taking into some chunk options, like results="asis")

Usage

eval.chunks.in.text(rmd, envir = parent.frame())
eval.chunks.in.text(rmd, envir = parent.frame())

Evaluate a placeholder and return its value

Description

Evaluate a placeholder and return its value

Usage

eval.placeholder(
  ph,
  envir = parent.frame(),
  chunks = "knit",
  dir = getwd(),
  out.type = "html",
  cr = NULL,
  on.error = c("null", "error", "stop")[1],
  use.commonmark = TRUE,
  ...
)
eval.placeholder(
  ph,
  envir = parent.frame(),
  chunks = "knit",
  dir = getwd(),
  out.type = "html",
  cr = NULL,
  on.error = c("null", "error", "stop")[1],
  use.commonmark = TRUE,
  ...
)

Evaluate placeholders in compiled rmd

Description

Evaluate placeholders in compiled rmd

Usage

eval.placeholders(
  cr = NULL,
  envir = parent.frame(),
  ph = cr$ph,
  type = NULL,
  on.error = c("null", "error", "stop")[1],
  out.type = first.none.null(cr$out.type, "html"),
  ...
)
eval.placeholders(
  cr = NULL,
  envir = parent.frame(),
  ph = cr$ph,
  type = NULL,
  on.error = c("null", "error", "stop")[1],
  out.type = first.none.null(cr$out.type, "html"),
  ...
)

compile all given types of rmd blocks

Description

compile all given types of rmd blocks

Usage

eval.rmd.blocks.in.text(
  txt,
  to = "html",
  envir = parent.frame(),
  call.list = NULL,
  block.df = NULL,
  only.types = NULL,
  ignore.types = "if",
  use.del.rows.na = FALSE,
  replace.funs = NULL
)
eval.rmd.blocks.in.text(
  txt,
  to = "html",
  envir = parent.frame(),
  call.list = NULL,
  block.df = NULL,
  only.types = NULL,
  ignore.types = "if",
  use.del.rows.na = FALSE,
  replace.funs = NULL
)

evaluate whiskers and replace them in the text

Description

evaluate whiskers and replace them in the text

Usage

eval.whiskers.in.text(
  str,
  envir = parent.frame(),
  signif = getOption("whiskerSignifDigits"),
  round = getOption("whiskerRoundDigits"),
  add.params = TRUE,
  whiskers.call.list = NULL
)
eval.whiskers.in.text(
  str,
  envir = parent.frame(),
  signif = getOption("whiskerSignifDigits"),
  round = getOption("whiskerRoundDigits"),
  add.params = TRUE,
  whiskers.call.list = NULL
)

Create a data_frame (tibble) considerably faster

Description

columns must all be named and cannot be computed from earlier columns

Usage

fast_df(...)
fast_df(...)

Find blocks that have only a starting line of the form

Description

#. type arguments

Usage

find.dot.blocks(
  txt,
  dot.levels = NULL,
  dot.start = "#. ",
  single.line.level = Inf
)
find.dot.blocks(
  txt,
  dot.levels = NULL,
  dot.start = "#. ",
  single.line.level = Inf
)

Find all rmd blocks that start with a line '#< ...' and end with a line '#>'

Description

Find all rmd blocks that start with a line '#< ...' and end with a line '#>'

Usage

find.rmd.blocks(txt)
find.rmd.blocks(txt)

Arguments

txt

the rmd code, separated into lines

Value

A data_frame with the columns start, end, type, arg.str or NULL if no block was found

Find the start and end lines of all rmd chunks

Description

Find the start and end lines of all rmd chunks

Usage

find.rmd.chunks(rmd, add.code = FALSE)
find.rmd.chunks(rmd, add.code = FALSE)

Arguments

rmd

the rmd code as character vector, one element per line

find blocks, chunks and dot blocks and add nesting info

Description

find blocks, chunks and dot blocks and add nesting info

Usage

find.rmd.nested(txt, dot.levels = NULL)
find.rmd.nested(txt, dot.levels = NULL)

Arguments

txt

the rmd source as character vector, each line one element

dot.levels

a list that describes the level of dot block types

Value

a data.frame

Find the parent index of each row given a vector levels that describes the nestedness

Description

Find the parent index of each row given a vector levels that describes the nestedness

Usage

get.levels.parents(levels, is.parent.type = NULL)
get.levels.parents(levels, is.parent.type = NULL)

Arguments

levels

integer vector of levels must start with lowest level and increase by 1 or decrease to an integer number

is.parent.type

NULL or a optional boolean vector of those rows that are of a type for which children shall be found.

Value

a vector of parent indices or 0 for most outer levels

Find the parent index of each row given a vector levels that describes the nestedness

Description

Find the parent index of each row given a vector levels that describes the nestedness

Usage

get.levels.parents.by.types(
  levels,
  types,
  parent.types = setdiff(unique(types), c(NA))
)
get.levels.parents.by.types(
  levels,
  types,
  parent.types = setdiff(unique(types), c(NA))
)

Arguments

levels

integer vector of levels must start with lowest level and increase by 1 or decrease to an integer number

types

character vector of types

parent.types

the parent.types that shall be characterized

Value

a matrix of parent type indices with length(levels) rows and length(parent.types) columns. If there is no parent type, we enter a 0.

Find the levels given ordered start and end positions of possible nested blocks

Description

Find the levels given ordered start and end positions of possible nested blocks

Usage

get.start.end.levels(start, end, start.level = 1L)
get.start.end.levels(start, end, start.level = 1L)

Arguments

start

vector of start positions of the blocks

end

vector of end positions of the blocks

start.level

the initial level

Value

a vector of levels of each blocks, moore deeply nested blocks have higher levels

Gets for each element the index of its type

Description

Gets for each element the index of its type

Usage

get.types.inds(types)
get.types.inds(types)

Arguments

types

a character vector of types

A button that toogles whether content in a div is displayed or not

Description

A button that toogles whether content in a div is displayed or not

Usage

hideShowButton(
  id,
  label,
  content = NULL,
  div.id = NULL,
  shown = FALSE,
  div.class = NULL,
  ...
)
hideShowButton(
  id,
  label,
  content = NULL,
  div.id = NULL,
  shown = FALSE,
  div.class = NULL,
  ...
)

own function to print a compact html table from a data frame with option to select row

Description

own function to print a compact html table from a data frame with option to select row

Usage

html.table(
  df,
  sel.row = NULL,
  col.names = TRUE,
  row.names = FALSE,
  border = TRUE,
  bg.color = c("#dddddd", "#ffffff"),
  font.size = "80%",
  round.digits = 8,
  signif.digits = 8,
  col.tooltips = NULL,
  ...
)
html.table(
  df,
  sel.row = NULL,
  col.names = TRUE,
  row.names = FALSE,
  border = TRUE,
  bg.color = c("#dddddd", "#ffffff"),
  font.size = "80%",
  round.digits = 8,
  signif.digits = 8,
  col.tooltips = NULL,
  ...
)

Variant of htmltools::htmlTemplate

Description

Variant of htmltools::htmlTemplate

Usage

html.template(
  file = NULL,
  html = NULL,
  envir = parent.frame(),
  document_ = "auto"
)
html.template(
  file = NULL,
  html = NULL,
  envir = parent.frame(),
  document_ = "auto"
)

A more convenient yaml importer

Description

A more convenient yaml importer

Usage

import.yaml(
  file = NULL,
  text = NULL,
  verbose = FALSE,
  keep.quotes = FALSE,
  quote.char = "__QUOTE__",
  catch.error = TRUE,
  check.by.row = FALSE,
  utf8 = TRUE
)
import.yaml(
  file = NULL,
  text = NULL,
  verbose = FALSE,
  keep.quotes = FALSE,
  quote.char = "__QUOTE__",
  catch.error = TRUE,
  check.by.row = FALSE,
  utf8 = TRUE
)

Inline dependencies with local file references

Description

Inline dependencies with local file references

Usage

inline.dependencies(deps, mustWork = TRUE)
inline.dependencies(deps, mustWork = TRUE)

Inline a dependency with local file references

Description

Inline a dependency with local file references

Usage

inline.dependency(dependency, mustWork = TRUE)
inline.dependency(dependency, mustWork = TRUE)

Knits a single rmd knitr chunk Has several options. The output can be given as html, shiny tag or markdown eval_mode = "sculpt" shows shows the final output ommiting all intermediate results and messages deps.action ="add" adds back dependecies to html or shiny tag. Important for rendering shiny widgets deps.action ="relative" also changes absolute dependencies to relative dependencies based on a package. That is important if we want to save the generated shiny tag and use it as part of a shiny application on another computer.

Description

Knits a single rmd knitr chunk Has several options. The output can be given as html, shiny tag or markdown eval_mode = "sculpt" shows shows the final output ommiting all intermediate results and messages deps.action ="add" adds back dependecies to html or shiny tag. Important for rendering shiny widgets deps.action ="relative" also changes absolute dependencies to relative dependencies based on a package. That is important if we want to save the generated shiny tag and use it as part of a shiny application on another computer.

Usage

knit.chunk(
  text,
  envir = parent.frame(),
  fragment.only = TRUE,
  quiet = TRUE,
  encoding = getOption("encoding"),
  html.table = TRUE,
  out.type = c("html", "shiny")[1],
  knit.dir = getwd(),
  use.commonmark = TRUE,
  deps.action = c("add", "relative", "ignore")[1],
  args = NULL,
  eval_mode = c("knit", "sculpt", "sculpt_asis", "eval", "html")[1],
  show_code = c("no", "note", "open_note", "note_after", "open_note_after", "before",
    "after")[1],
  code.highlight = use.commonmark,
  add.meta.attr = TRUE,
  remove.empty.html.comments = TRUE,
  ...
)
knit.chunk(
  text,
  envir = parent.frame(),
  fragment.only = TRUE,
  quiet = TRUE,
  encoding = getOption("encoding"),
  html.table = TRUE,
  out.type = c("html", "shiny")[1],
  knit.dir = getwd(),
  use.commonmark = TRUE,
  deps.action = c("add", "relative", "ignore")[1],
  args = NULL,
  eval_mode = c("knit", "sculpt", "sculpt_asis", "eval", "html")[1],
  show_code = c("no", "note", "open_note", "note_after", "open_note_after", "before",
    "after")[1],
  code.highlight = use.commonmark,
  add.meta.attr = TRUE,
  remove.empty.html.comments = TRUE,
  ...
)

Knits the rmd txt

Description

Knits the rmd txt

Usage

knit.rmd(
  text,
  envir = parent.frame(),
  fragment.only = TRUE,
  quiet = TRUE,
  encoding = getOption("encoding"),
  html.table = TRUE,
  out.type = "html",
  use.commonmark = FALSE
)
knit.rmd(
  text,
  envir = parent.frame(),
  fragment.only = TRUE,
  quiet = TRUE,
  encoding = getOption("encoding"),
  html.table = TRUE,
  out.type = "html",
  use.commonmark = FALSE
)

Knits the rmd txt inside a temporary directory instead of the current wd

Description

Does not create /figure subfolder in current wd

Usage

knit.rmd.in.temp(text, envir = parent.frame(), ...)
knit.rmd.in.temp(text, envir = parent.frame(), ...)

Parse a n rmd chunk and store info in a list

Description

Parse a n rmd chunk and store info in a list

Usage

make.chunk.info(txt, id = NULL)
make.chunk.info(txt, id = NULL)

Make a info for a placeholder object

Description

Make a info for a placeholder object

Usage

make.placeholder.info(txt, type, form)
make.placeholder.info(txt, type, form)

Parse a whisker and create meta info

Description

Parse a whisker and create meta info

Usage

make.whisker.info(txt, add.variables = FALSE)
make.whisker.info(txt, add.variables = FALSE)

Change in a lst of dependencies absolute paths in scr$file to a relative path based on a package

Description

Change in a lst of dependencies absolute paths in scr$file to a relative path based on a package

Usage

makeDependenciesRelativeToPackage(deps)
makeDependenciesRelativeToPackage(deps)

Change in an dependency an absolute path in scr$file to a relative path based on a package

Description

Change in an dependency an absolute path in scr$file to a relative path based on a package

Usage

makeDependencyRelativeToPackage(dep)
makeDependencyRelativeToPackage(dep)

Recursively encode strings in list as UTF-8

Description

Recursively encode strings in list as UTF-8

Usage

mark_utf8(x)
mark_utf8(x)

Own markdown to html converter that interfaces commonmark

Description

Own markdown to html converter that interfaces commonmark

Usage

md2html(
  text,
  fragment.only = TRUE,
  options = c("use_xhtml", "mathjax", if (include.images) "base64_images" else NULL,
    "highlight_code"),
  include.images = TRUE,
  smart = FALSE,
  use.commonmark = FALSE,
  ...
)
md2html(
  text,
  fragment.only = TRUE,
  options = c("use_xhtml", "mathjax", if (include.images) "base64_images" else NULL,
    "highlight_code"),
  include.images = TRUE,
  smart = FALSE,
  use.commonmark = FALSE,
  ...
)

Arguments

text

the variable containing the markdown text

fragment.only

only a fragment or should html headers be added

options

options to markdownToHTML. These are the default options without smartypants

smart

smart punctuation (relevant for commonmark)

use.commonmark

use commonmark instead of markdownToHTML (no mathjax and included images)...

Value

The created HTML as a string

Normalize an id to letters that are allowed

Description

Normalize an id to letters that are allowed

Usage

normalize.id(str, allowed = c(letters, LETTERS, 0:9, "_"), subst = "_")
normalize.id(str, allowed = c(letters, LETTERS, 0:9, "_"), subst = "_")

Parse an arg.str as list

Description

Parse an arg.str as list

Usage

parse.arg.str(arg.str)
parse.arg.str(arg.str)

Parse the name of an rmd block

Description

Parse the name of an rmd block

Usage

parse.block.args(
  header,
  arg.str = NULL,
  add.type = TRUE,
  type = "",
  allow.unquoted.title = FALSE
)
parse.block.args(
  header,
  arg.str = NULL,
  add.type = TRUE,
  type = "",
  allow.unquoted.title = FALSE
)

Parse the name of a knitr chunk and its arguments

Description

Parse the name of a knitr chunk and its arguments

Usage

parse.chunk.args(header, arg.str = NULL)
parse.chunk.args(header, arg.str = NULL)

Take a vector of chunk header lines and returns the chunk names

Description

Take a vector of chunk header lines and returns the chunk names

Usage

parse.chunk.names(header)
parse.chunk.names(header)

Arguments

the chunk headers

Parse a hashdot yaml string

Description

Parse a hashdot yaml string

Usage

parse.hashdot.yaml(txt, hashdot = "#. ", ...)
parse.hashdot.yaml(txt, hashdot = "#. ", ...)

Subtitutes whiskers and pastes string parts together

Description

Unlike replace whiskers, returns a string vector if whiskers evaluate as vectors Cannot deal with nested whiskers

Usage

paste.whiskers(
  str,
  values = parent.frame(),
  eval = TRUE,
  signif.digits = NULL,
  error.val = "`Error`",
  empty.val = NULL,
  whisker.start = "{{",
  whisker.end = "}}",
  sep = "",
  collapse = NULL,
  return.list = FALSE
)
paste.whiskers(
  str,
  values = parent.frame(),
  eval = TRUE,
  signif.digits = NULL,
  error.val = "`Error`",
  empty.val = NULL,
  whisker.start = "{{",
  whisker.end = "}}",
  sep = "",
  collapse = NULL,
  return.list = FALSE
)

Prints list read from a yaml file

Description

Prints list read from a yaml file

Usage

## S3 method for class 'yaml'
print(obj)
## S3 method for class 'yaml'
print(obj)

Create n random strings of length nchar each

Description

Create n random strings of length nchar each

Usage

random.string(n = 1, nchar = 14)
random.string(n = 1, nchar = 14)

Read a text file and convert to UTF-8

Description

Read a text file and convert to UTF-8

Usage

read.as.utf8(file, sep.lines = TRUE, warn = FALSE, ...)
read.as.utf8(file, sep.lines = TRUE, warn = FALSE, ...)

Reads a yaml file and returns as a list

Description

Reads a yaml file and returns as a list

Usage

read.yaml(
  file = NULL,
  verbose = FALSE,
  keep.quotes = TRUE,
  quote.char = "__QUOTE__",
  text = NULL,
  catch.error = TRUE,
  check.by.row = FALSE,
  space.after.colon = FALSE,
  utf8 = TRUE
)
read.yaml(
  file = NULL,
  verbose = FALSE,
  keep.quotes = TRUE,
  quote.char = "__QUOTE__",
  text = NULL,
  catch.error = TRUE,
  check.by.row = FALSE,
  space.after.colon = FALSE,
  utf8 = TRUE
)

Read a text file that was saved in UTF-8 format

Description

Read a text file that was saved in UTF-8 format

Usage

readUtf8(file, sep.lines = TRUE, warn = FALSE, ...)
readUtf8(file, sep.lines = TRUE, warn = FALSE, ...)

Remove quotes from strings

Description

Remove quotes from strings

Usage

remove.quotes(str, quotes = c("'", "\""))
remove.quotes(str, quotes = c("'", "\""))

Removes the rmd chunks with the given chunk names from rmd code

Description

Removes the rmd chunks with the given chunk names from rmd code

Usage

remove.rmd.chunks(rmd, chunk.names)
remove.rmd.chunks(rmd, chunk.names)

Arguments

rmd

the rmd code as character vector, one element per line

chunk.names

the list of rmd chunks that shall be removed

Render a compiled rmd

Description

Render a compiled rmd

Usage

render.compiled.rmd(
  cr = NULL,
  txt = cr$body,
  envir = parent.frame(),
  fragment.only = FALSE,
  chunks = c("knit", "eval")[1],
  out.type = if (is.null(cr$out.type)) "html" else cr$out.type,
  use.print = "none",
  overwrite.values = FALSE,
  on.error = "error",
  use.commonmark = TRUE
)
render.compiled.rmd(
  cr = NULL,
  txt = cr$body,
  envir = parent.frame(),
  fragment.only = FALSE,
  chunks = c("knit", "eval")[1],
  out.type = if (is.null(cr$out.type)) "html" else cr$out.type,
  use.print = "none",
  overwrite.values = FALSE,
  on.error = "error",
  use.commonmark = TRUE
)

Render a list of dependencies as a list of singleton head tags TO DO: Some dependencies may use local file names... Those dependencies must be fully inlined...

Description

Render a list of dependencies as a list of singleton head tags TO DO: Some dependencies may use local file names... Those dependencies must be fully inlined...

Usage

render.deps.as.singletons.tags(deps, inline.local.files = TRUE)
render.deps.as.singletons.tags(deps, inline.local.files = TRUE)

Render with RMarkdown::render the rmd txt inside a temporary directory instead of the current wd

Description

Does not create /figure subfolder in current wd

Usage

render.rmd.in.temp(text, envir = parent.frame(), quiet = TRUE, ...)
render.rmd.in.temp(text, envir = parent.frame(), quiet = TRUE, ...)

Render a value in a format specified by out.type

Description

Render a value in a format specified by out.type

Usage

render.value(val, out.type = "html", ...)
render.value(val, out.type = "html", ...)

extract #< if blocks from a rmd txt

Description

extract #< if blocks from a rmd txt

Usage

replace.if.blocks(
  txt,
  envir = parent.frame(),
  call.list = NULL,
  block.df = NULL,
  warn.if.na = TRUE,
  del.rows.na = FALSE,
  if.df = NULL
)
replace.if.blocks(
  txt,
  envir = parent.frame(),
  call.list = NULL,
  block.df = NULL,
  warn.if.na = TRUE,
  del.rows.na = FALSE,
  if.df = NULL
)

replace whiskers using a list of values, with several options

Description

replace whiskers using a list of values, with several options

Usage

replace.whiskers(
  str,
  values = parent.frame(),
  eval = TRUE,
  signif.digits = NULL,
  vector.return.first = use.print == "none",
  pos = NULL,
  error.val = "`Error`",
  empty.val = NULL,
  use.whisker.render = FALSE,
  whisker.start = "{{",
  whisker.end = "}}",
  use.print = c("none", "knit", "whisker")[1]
)
replace.whiskers(
  str,
  values = parent.frame(),
  eval = TRUE,
  signif.digits = NULL,
  vector.return.first = use.print == "none",
  pos = NULL,
  error.val = "`Error`",
  empty.val = NULL,
  use.whisker.render = FALSE,
  whisker.start = "{{",
  whisker.end = "}}",
  use.print = c("none", "knit", "whisker")[1]
)

Reverses whisker placeholders by their original whiskers

Description

May be useful if blocks evaluate whiskers themselves or after rmd to html transformation

Usage

reverse.whisker.placeholders(txt, ph = cr$ph, cr = NULL)
reverse.whisker.placeholders(txt, ph = cr$ph, cr = NULL)

Extract rmd txt between start.line and end.line tag

Description

Extract rmd txt between start.line and end.line tag

Usage

rmd.between.start.end.lines(
  txt,
  start.line = "<!-- START -->",
  end.line = "<!-- END -->",
  return.start.end = FALSE
)
rmd.between.start.end.lines(
  txt,
  start.line = "<!-- START -->",
  end.line = "<!-- END -->",
  return.start.end = FALSE
)

Replace blocks with placeholderss of the form id

Description

TODO: Need to deal with nested blocks: replace from inner to outer

Usage

rmd.blocks.to.placeholders(
  txt,
  block.df = NULL,
  whisker.prefix = "{{",
  whisker.postfix = "}}",
  del.rows.na = FALSE,
  ignore.types = NULL,
  only.types = NULL,
  add.info = TRUE,
  ...
)
rmd.blocks.to.placeholders(
  txt,
  block.df = NULL,
  whisker.prefix = "{{",
  whisker.postfix = "}}",
  del.rows.na = FALSE,
  ignore.types = NULL,
  only.types = NULL,
  add.info = TRUE,
  ...
)

Replace chunks with placeholderss of the form id

Description

Replace chunks with placeholderss of the form id

Usage

rmd.chunks.to.placeholders(
  txt,
  whisker.prefix = "{{",
  whisker.postfix = "}}",
  del.rows.na = FALSE,
  add.info = TRUE,
  id = NULL
)
rmd.chunks.to.placeholders(
  txt,
  whisker.prefix = "{{",
  whisker.postfix = "}}",
  del.rows.na = FALSE,
  add.info = TRUE,
  id = NULL
)

Replace whiskers with placeholders of the form id

Description

Replace whiskers with placeholders of the form id

Usage

rmd.whiskers.to.placeholders(
  txt,
  whisker.prefix = "{{",
  whisker.postfix = "}}",
  add.info = TRUE
)
rmd.whiskers.to.placeholders(
  txt,
  whisker.prefix = "{{",
  whisker.postfix = "}}",
  add.info = TRUE
)

Like paste0 but returns an empty vector if some string is empty

Description

Like paste0 but returns an empty vector if some string is empty

Usage

sc(..., sep = "", collapse = NULL)
sc(..., sep = "", collapse = NULL)

A simple html page

Description

A simple html page

Usage

simple.html.page(head, body)
simple.html.page(head, body)

Splits a text vector into different blocks by a start line token

Description

Splits a text vector into different blocks by a start line token

Usage

## S3 method for class 'by.line.start'
split(
  txt,
  start.with = NULL,
  block.lines = NULL,
  add.start = TRUE,
  merge.lines = TRUE
)
## S3 method for class 'by.line.start'
split(
  txt,
  start.with = NULL,
  block.lines = NULL,
  add.start = TRUE,
  merge.lines = TRUE
)

Value

a data frame

knitr data.frame printer as nice HTML table with several options

Description

knitr data.frame printer as nice HTML table with several options

Usage

table.knit_print.data.frame(
  x,
  table.max.rows = 100,
  round.digits = 8,
  signif.digits = 8,
  html.data.frame = TRUE,
  show.col.tooltips = TRUE,
  col.tooltips = NULL,
  output = "html",
  options = NULL,
  ...
)
table.knit_print.data.frame(
  x,
  table.max.rows = 100,
  round.digits = 8,
  signif.digits = 8,
  html.data.frame = TRUE,
  show.col.tooltips = TRUE,
  col.tooltips = NULL,
  output = "html",
  options = NULL,
  ...
)

Tag a shiny tag or a list of tags, and transform all dependencies with the function transform.fun which takes a list of dependecies as argument

Description

Tag a shiny tag or a list of tags, and transform all dependencies with the function transform.fun which takes a list of dependecies as argument

Usage

transformTagDependencies(tags, transform.fun = identity)
transformTagDependencies(tags, transform.fun = identity)

View an extended rmd file

Description

View an extended rmd file

Usage

view.html(
  file = NULL,
  text = if (!is.null(file)) readLines(file, warn = FALSE) else NULL,
  ui = NULL,
  browser = rstudio::viewer,
  dir = getwd()
)
view.html(
  file = NULL,
  text = if (!is.null(file)) readLines(file, warn = FALSE) else NULL,
  ui = NULL,
  browser = rstudio::viewer,
  dir = getwd()
)

View an extended rmd file

Description

View an extended rmd file

Usage

view.rmd(
  file = NULL,
  text = readLines(file, warn = FALSE),
  envir = list(),
  start.line = "<!-- START -->",
  end.line = "<!-- END -->",
  set.utf8 = TRUE,
  knit = !chunks.like.whisker,
  chunks.like.whisker = FALSE,
  out.type = "shiny",
  launch.browser = rstudio::viewer,
  use.commonmark = FALSE
)
view.rmd(
  file = NULL,
  text = readLines(file, warn = FALSE),
  envir = list(),
  start.line = "<!-- START -->",
  end.line = "<!-- END -->",
  set.utf8 = TRUE,
  knit = !chunks.like.whisker,
  chunks.like.whisker = FALSE,
  out.type = "shiny",
  launch.browser = rstudio::viewer,
  use.commonmark = FALSE
)

Print a whisker object

Description

Print a whisker object

Usage

whisker_print(x, ...)
whisker_print(x, ...)

Need to implement different methods

Description

Need to implement different methods

Usage

## Default S3 method:
whisker_print(x, ...)
## Default S3 method:
whisker_print(x, ...)

Write text file in UTF-8 format

Description

Write text file in UTF-8 format

Usage

writeUtf8(x, file, bom = F)
writeUtf8(x, file, bom = F)

Package 'rmdtools'

Help Index

Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluation

Description

Usage

Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluation

Description

Usage

Add code button with div to an ui

Description

Usage

Create a Rmd chunk header line from a list of arguments

Description

Usage

Scan all used block and whisker parameters in an .rmd file and create a template for a list

Description

Usage

cat.whisker params

Description

Usage

Translates a chunk header to a list of its option

Description

Usage

Arguments

Main function to compile rmd to html

Description

Usage

Render a knitr chunk in the same way as a whisker (taking into some chunk options, like results="asis")

Description

Usage

Render all knitr chunks in the same way as a whisker (taking into some chunk options, like results="asis")

Description

Usage

Evaluate a placeholder and return its value

Description

Usage

Evaluate placeholders in compiled rmd

Description

Usage

compile all given types of rmd blocks

Description

Usage

evaluate whiskers and replace them in the text

Description

Usage

Create a data_frame (tibble) considerably faster

Description

Usage

Find blocks that have only a starting line of the form

Description

Usage

Find all rmd blocks that start with a line '#< ...' and end with a line '#>'

Description

Usage

Arguments

Value

Find the start and end lines of all rmd chunks

Description

Usage

Arguments

find blocks, chunks and dot blocks and add nesting info

Description

Usage

Arguments

Value

Find the parent index of each row given a vector levels that describes the nestedness

Description

Usage

Arguments

Value

Find the parent index of each row given a vector levels that describes the nestedness

Description

Usage

Arguments

Value

Find the levels given ordered start and end positions of possible nested blocks

Description

Usage

Arguments

Value