Create Reports Using R and 'asciidoc'

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



output: github_document

pipeline status
coverage report

CRAN_Status_Badge RStudio_downloads_monthly RStudio_downloads_total

Introduction

Please read the vignette.

Or, after installation, the help page:

help("rasciidoc-package", package = "rasciidoc")
#> Create Reports Using R and 'asciidoc'
#> 
#> Description:
#> 
#>      Inspired by Karl Broman`s reader on using 'knitr' with 'asciidoc'
#>      (<URL: http://kbroman.org/knitr_knutshell/pages/asciidoc.html>),
#>      this is merely a wrapper to 'knitr' and 'asciidoc'.
#> 
#> 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.

Installation

You can install rasciidoc from github with:

if (! require("remotes")) install.packages("remotes")
remotes::install_gitlab("fvafrCU/rasciidoc")

News

rasciidoc 2.0.0

  • Fixed quotation in DESCRIPTION.
  • Fixed excerption for input files mixing slidy and standard asciidoc.
  • Refactored render().
  • Got rid of render_slides().
  • Remove tagged lines from input docs.
  • Now by default using tempdir(), which breaks internal links and source().

rasciidoc 1.0.0

  • Improve testing.
  • Checked for spelling, lints and cleanr.
  • Allow for skipping single lines in slidy output by tagging them with "//no_slide".
  • Now keeping intermediate files from render_slides(), too.

rascidoc 0.9.0

  • knitr's output hooks are now reset to their former values after knitting.
  • Added an argument 'clean' to render() to clean intermediate files.

rasciidoc 0.8.0

  • render() now passed arguments to adjust knitr's asciidoc hooks.

rasciidoc 0.7.0

  • render() now uses a working directory that defaults to the input file's directory, allowing for the default file to source code.

rasciidoc 0.6.0

  • render() now works for R files with markup in roxygen comments that are parsed trough knitr::spin().

rasciidoc 0.5.0

  • Passed the parent.frame() down to knitr to always be in .GlobalEnv.

rasciidoc 0.4.0

  • Add //[begin|end]\_only\_slide-blocks and //slide\_only-comments to allow for content for slidy only.
  • Fix broken code inclusions for slidy.

rasciidoc 0.3.0

  • Made adjusting knitr's hooks (see rasciidoc 0.2.0) the default behaviour.

rasciidoc 0.2.0

  • Added function to adjust knitr's hooks for asciidoc files, providing a work around for not using asciidoc's [MESSAGE|WARNING|ERROR] when knitting produces a message|warning|error.

rasciidoc 0.1.0

  • Added core functionality.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("rasciidoc")

2.0.0 by Andreas Dominik Cullmann, 7 months ago


https://github.com/fvafrcu/rasciidoc


Browse source code at https://github.com/cran/rasciidoc


Authors: Andreas Dominik Cullmann [aut, cre]


Documentation:   PDF Manual  


BSD_2_clause + file LICENSE license


Imports document, knitr, highr

Suggests rmarkdown, testthat, RUnit, devtools, rprojroot, withr, pkgload

System requirements: asciidoc (<https://asciidoc.org>), source-highlight is recommend.


See at CRAN