Facilitating the creation of reproducible statistical report templates. Once created, rapport templates can be exported to various external formats (HTML, LaTeX, PDF, ODT etc.) with pandoc as the converter backend.
MAJOR VERSION BUMP
We started the
rapport package back in 2011 but never thought of that the version number should ever exceed ONE - because we are shy guys. Now, almost 3 years later, so much stuff have changes in the package, that time has come for a major version bump. Most important updates since the birth of the package:
ascii) and implemented custom solutions for our custom needs
panderpackage in the name of modularity
panderbecame more popular compared to
tpl) not to confuse new-comers
Most recent changes since 0.51:
rpprefix for all those (rp.max became max -- for those who load the package directly)
tplprefix for tempalte functions as was confusing and every
rapporttemplate specific function starts with
Please note that the functions can still be accessed by the old names to preserve backward-compatibility, but will be definitely removed later to keep the clutter in the namespace at a minimal level. So please be advised to update your functions if building on the top (or parts) of
Full list of changed function and variable names:
Function name changes:
Variable name changes inside of templates:
Option name changes:
match.argfor matching any more. Instead, a simple
%in%with indexing is used, so exact match is required.
valueattribute is not used to store values that you choose from -
optionsattribute is used instead, with
valueholding the (default) value(s) from the
allow_multiplewas introduced in matchable inputs. If
TRUE, it will allow one to match values from
optionslist multiple times. Defaults to
TEMPLATE HEADER SPECIFICATION
?tpl.inputsfor details on new metadata and input specification.
lengthchecks are manageable via
optioninputs are removed. You should use
factorinputs instead. Multiple matches are now allowed.
numberinputs are removed and
numericare to be used instead, respectively.
nlevelsfor factors, or
ncharfor character vectors.
yamlpackage to dependencies.
tpl.metawill now perform validation of inputs and metadata, respectively. Warnings are issued if unsupported fields are found.
dataRequiredmetadata attribute is deprecated. Dataset is required if the template contains non-standalone inputs (see
TRUEfor zero-length objects.
YAML INPUT SPECIFICATION
evaluate packages and introduced
This was a quite big change in the backend which resulted in some removed functions of prior version.
tpl.tangle is dropped temporarily and most of the custom options were moved to
the repository was moved to Rapporter's organisation GH account from @aL3xa
tpl.exportreturns the generated document's filename
This is a hotfix release:
RJSONIOdependency (just like:
kurtosis()functions to get rid of
latticeExtrafrom package dependencies.
rapport()will now check for packages specified in the template header and throw error if something goes wrong while loading.
readlinesinstead of reading from
stdin(Windows and Eclipse/StatET bug)
tpl.exportnow checks if specified backend is installed and throws an error if not.
evalsis done with the help of
replayPlotinstead of file size checks (for OS independence).
Initial CRAN release.