Release 0.5.0

This release brings a number of improvements for tables.

Overview

• It is now easy to add download links to table captions (see below).
• Revised the way in which table captions are generated to improve
  their appearance.

Table downloads

It is now possible to easily add a download link to table captions, similar
to the way figure captions offer a download of the PDF figure. To use this
feature, pass the R object that should be made available for download
to the download chunk option. This will save the object to a file and add
a corresponding download link to the table caption. If the R object is
a data.frame (or can be coerced to one) its contents will be saved as
a text file. All other objects are saved to RData files.

Release 0.4.0

This release provides a number of new features and improvements:

• Better control over the size and appearance of figures.
  • Use fig_width and fig_height to set the figure size. Either document wide in the YAML header or
    in the options for a figure chunk.
  • Set the size of thumbnails in the YAML header using thumbnail_size. This should be an integer between
    1 and 12, where 12 corresponds to the width of the main text. By default, thumbnails are 50% of the text width.
    The use of even numbers is recommended to allow for centring of figures.
  • Use thumbnail: false in the YAML header to disable thumbnails entirely.
  • figcap_prefix, figcap_sep and figcap_prefix_highlight control the appearance of the figure label.
    tabcap_* options do the same for tables.
• Support for links to anchors in child documents.
  • The objects used by reportMD to store information about child documents can be used to generate links to
    anchors, e.g. to headings or code chunks, in those documents. See the
    documentation for details.
• Full support for MathJax (thanks to Patrick Schratz).

Release 0.3.2

This is a bugfix release that addresses a few different issues:

• There was an issue with referencing figures in child documents that caused an error when the name assigned to
  the child in the referring document didn't match the file name of the child document. It should now be possible
  to use any valid R name, as was intended.
• Using child documents that don't generate any extra files (figures, etc.) will no longer generate a warning.
  Previously an attempt was made to copy the files directory, even if it didn't exist.
• The README now has a (long overdue) reference to knitrBootstrap.

Release v0.3.1

This is a bug fix release, addressing an issue with the handling of the use_namespace option introduced in the previous release.

Release 0.3.0

Scoping for child documents

When working with complex document structures it is often desirable to maintain some separation between variables defined in different child documents. This is now much easier with the option to create scopes for child documents. When the newly introduced document option use_namespace is set to true all objects loaded from child documents will be placed in a document specific environment, which is accessible by the name assigned to that child document in the yaml metadata.

Example

Consider a report that contains a document with the following yaml header.

output:
  reportMD::multi_document:
    depends:
      part1: part1.Rmd
      part2: part2.Rmd
    use_namespace: true

Where part1.Rmd contains an R chunk

    ```{r compute_x}
    x <- 6*9
    ```

and part2.Rmd contains

    ```{r x}
    x <- 42
    ```

We can now access both versions of x in the same chunk of the main document.

    ```{r the_answer, dependson=c('part1:compute_x', 'part2:x')}
    part1$x != part2$x
    ```

Release 0.2.1

This is a bugfix release addressing an issue with links to figures in child documents.

Release v0.2.0

This release introduces a document format for Rmarkdown to support multi-part reports. Compared to earlier versions this dramatically reduces the amount of setup required in the Rmarkdown documents, making it a lot easier to use. This also means that reportMD no longer relies on the document format provided by the development version of knitrBootstrap, making installation a bit easier.

The styling of the produced HTML documents has been revised as well. The most notable change is that code chunks and their output are handled differently now, All output from a code chunk can now be displayed or hidden with a single click. Previously each generated code block, output, warning and error had to be toggled separately. This also helps to reduce clutter from code chunks that produce several outputs.

Release v0.1.0

This is the first release of the reportMD R package. It provides basic functionality to generate multi-page HTML reports as well as some convenience features, e.g. automatic numbering of Figures and Tables. Please see the README for further details.

Installation

A source package as well as a Windows binary are available for download below. Alternatively use
devtools::install_github('humburg/reportmd', ref='v0.1.0') to install directly from GitHub.