Create Reports Using R and asciidoc

Description

Inspired by Karl Broman's reader on using knitr with asciidoc (https://kbroman.org/knitr_knutshell/pages/asciidoc.html), this is merely a wrapper to knitr and asciidoc.

Arguments

Details

You will find the details in
vignette("An_Introduction_to_rasciidoc", package = "rasciidoc").

Warning

Due to the CRAN policy of not writing "anywhere else on the file system apart from the R session's temporary directory", we work on a temporary copy of file_name. Thus all internal sourcing and internal links will be broken and any output is written to tempdir(). Set the option "write_to_disk" to TRUE (using
options(write_to_disk = TRUE)
to bypass this. You may want to include the above line into your ‘~/.Rprofile’.

Adjust knitr's Hooks for asciidoc

Description

By default, knitr renders messages, warnings and errors to [NOTE|WARNING|ERROR]-blocks in asciidoc, which is ... not my choice. To restore knitr's behaviour, set hooks or replacement to NULL.

Usage

adjust_asciidoc_hooks(
  hooks = c("message", "error", "warning"),
  replacement = "source"
)

Arguments

Details

This is a modified version of render_asciidoc of knitr version 1.18.7.

Value

The return value of knit_hooks$set, invisibly NULL, currently.

Is a Version Requirement Met?

Description

Just a wrapper to compareVersion, I regularly forget how to use it.

Usage

is_version_sufficient(installed, required)

Arguments

Value

TRUE, if so, FALSE otherwise.

Examples

is_version_sufficient(installed = "1.0.0", required = "2.0.0")
is_version_sufficient(installed = "1.0.0", required = "1.0.0")

Is the System Running a Windows Machine?

Description

Is the System Running a Windows Machine?

Usage

is_windows()

Value

TRUE if so, FALSE otherwise.

Render an asciidoc File

Description

This is the basic interface to asciidoc. Not more than a call to system2 and checks on asciidoc and source-highlight. You should usually not call it directly, see render for a wrapper.

Usage

rasciidoc(
  file_name,
  ...,
  write_to_disk = getOption("write_to_disk"),
  enforce_requirements = getOption("enforce_requirements"),
  git_checkout_asciidoc_tag = NA
)

Arguments

Value

Invisibly TRUE or FALSE, depending on success.

Warning

Due to the CRAN policy of not writing "anywhere else on the file system apart from the R session's temporary directory", we work on a temporary copy of file_name. Thus all internal sourcing and internal links will be broken and any output is written to tempdir(). Set the option "write_to_disk" to TRUE (using
options(write_to_disk = TRUE)
to bypass this. You may want to include the above line into your ‘~/.Rprofile’.

See Also

render

Examples

# CRAN complains about elapsed times
if (fritools::is_running_on_fvafrcu_machines()) {
    wd <- file.path(tempdir(), "rasciidoc")
    dir.create(wd)
    file  <- system.file("files", "minimal", "knit.asciidoc",
                         package = "rasciidoc")
    file.copy(file, wd)
    r <- rasciidoc(file_name = file.path(wd, basename(file)),
                   write_to_disk = getOption("write_to_disk"), "-b html")
    if (interactive()) browseURL(attr(r, "info")[["output"]])
    if (isTRUE(getOption("write_to_disk"))) {
        dir(wd, full.names = TRUE)
    } else {
        dir(tempdir(), full.names = TRUE)
    }
    unlink(wd, recursive = TRUE)
}

Spin or Knit and Render a 'Rasciidoc' File

Description

Spin or Knit (if required) and render an 'Rasciidoc' file.

Usage

render(
  file_name,
  knit = NA,
  write_to_disk = getOption("write_to_disk"),
  envir = parent.frame(),
  hooks = c("message", "error", "warning"),
  replacement = "source",
  asciidoc_args = "-b html",
  what = c("auto", "all", "no_slides", "slides"),
  git_checkout_asciidoc_tag = NA,
  clean = FALSE,
  ...
)

Arguments

Value

The return value of rasciidoc.

Warning

Due to the CRAN policy of not writing "anywhere else on the file system apart from the R session's temporary directory", we work on a temporary copy of file_name. Thus all internal sourcing and internal links will be broken and any output is written to tempdir(). Set the option "write_to_disk" to TRUE (using
options(write_to_disk = TRUE)
to bypass this. You may want to include the above line into your ‘~/.Rprofile’.

See Also

rasciidoc

Examples

# CRAN complains about elapsed times
if (fritools::is_running_on_fvafrcu_machines()) {
    wd <- file.path(tempdir(), "rasciidoc")
    dir.create(wd)
    file  <- system.file("files", "minimal", "knit.Rasciidoc",
                         package = "rasciidoc")
    file.copy(file, wd)
    r <- rasciidoc::render(file.path(wd, basename(file)),
                           write_to_disk = getOption("write_to_disk"),
                           asciidoc_args = "-b slidy")
    if (isTRUE(getOption("write_to_disk"))) {
        dir(wd, full.names = TRUE)
    } else {
        dir(tempdir(), full.names = TRUE)
    }
    unlink(wd, recursive = TRUE)
}

Throw a Condition

Description

Throws a condition of class c("error", "rasciidoc", "condition").

Usage

throw(message_string, system_call = sys.call(-1), ...)

Arguments

Details

We use this condition as an error dedicated to rasciidoc.

Value

The function does never return anything, it stops with a condition of class c("error", "rasciidoc", "condition").