htmlreportR 1.0.0
htmlreportR 1.0.1
- New: Added prettify_div method to htmlReport class. Simplifies div
style customisation, and comes with some pretty presets.
- New: Added boxplot method to htmlReport class.
- New: Added reshape method to canvasXpress_obj class. Reshapes canvas
data structure to adapt to long and wide formats.
- New: Added script to convert Rmd templates to html, making them
compatible with htmlreportR. Relies on a new function
(replace_paired_mark) under utils.R
htmlreportR 2.0.0
- New: Overhauled whole basic structure, now more closely matches
python version. Usage has changed slightly, now rows and columns meant
to be names now should also be counted when specifying indices in
templates, as they are now treated as regular fields and rows up until
drawing the plot. Allowed implementation of the following feature.
- New: “fields” and “rows” arguments may now be added to calls of
plotting methods in templates. They allow to reorder and subset data
before plotting without altering the original data.
- Change: setting header to TRUE removes the first row specified by
“rows” from the actual data frame, setting it as its name. Same goes for
row_names and the first column specified by “fields”. You might need to
update var_attr and smp_attr in your templates after updating if any of
these values is set to TRUE.
- Update: “table” method now behaves like the rest, taking options
list as argument instead. You will need to update old calls to this
method (simply wrap arguments in a list).
- Update: “extract_data” method no longer takes data frame as input,
accesses it through hash_vars (reads ID from options list). This method
is not public, so it should not have any repercussions in regular
usage.
- Update: added make_html_list to general functions. Takes three
vectors: contents, levels (optional) and types (optional) and creates an
html list with them.
- Fix: plotting methods can now handle a smp_attr field that is
encoded in data frame as a factor
- New: heatmap method can now handle two data frames and represent
them in the same heatmap (second data frame must be an additional factor
of the first, think of it as adding a third dimension to data). Will be
represented by point sizes.
- New: added scatter3D method.
- New: added merge_hashed_tables method, takes a list of ids and some
optional arguments and merges hash_vars tables corresponding to those
ids.
- Update: table method now admits rownames_col argument in option
list, renames rownames column.
- Update: barplot method now includes option to color series by a
specified sample attribute.
- Update: prettify_div htmlReport method now admits height and width
arguments. Custom arguments now take priority over preset. Added new
inject_string argument, allows to fully customise style.
- Update: responsive parameter of CanvasXpress plotting methods in
htmlReport class now actually usable.
- New: main reporting script now prints a message when reading files,
so in case of error you know which file is the problematic one.
- New: row_to_header and col_to_rownames now exported.
- Update: showcase template now includes code in the rendered
report.
- Update: static_plot_ main now takes plotting_args argument, allows
you to pass arguments to plotting functions. See showcase report.
- New: added embed_html method to htmlReport class, uses iframes to
embed an html file. It requires manual editing because of how pandoc
enforces styles on embedded iframes (remove the style block inserted in
the iframe). Will be fixed in htmlreportR overhaul.
- New: Added table filtering by column values. See examples in demo
template and report.
- New: plot_grid method, which takes a list of plots and sets them in
a grid structure.
- Fix: static_plot_main can now use plotting_args when in autoplot
mode.
htmlreportR 2.0.1
- Update: example reports are no longer distributed with the package.
Generate them by running the launch.sh script under
tests/demo_examples!