Skip to content

Releases: insightsengineering/rtables

v0.6.10 cran

23 Sep 02:14
c6ee2da
Compare
Choose a tag to compare

New Features

  • Added top left information handling (now bold and bottom aligned).
  • Added section_properties_default() function to define standard portrait properties for tables.
  • Added default theme for .html outputs.
  • Added parameter bold_titles to tt_to_flextable() to bold titles.
  • Now users can add more than one theme to tt_to_flextable(), and/or extend themes.

Enhancements

  • Modified reorder_split_levels() to cover more edge cases and be more stringent in the allowed inputs.
  • Removed table tree tt input from theme_docx_default() and added code to handle row classes and number of columns internally.
  • Reworked padding and spacing in default theme theme_docx_default().
  • Added parameter bold_titles to tt_to_flextable() to bold titles.

Bug Fixes

  • Fixed "\n" newline issues in as_html by relying onto output devices for newline handling. Added expand_newlines = FALSE default to allow previous behavior.
  • keep_split_levels() throws now an error if the user requests to keep levels that are not present in data.
  • Fixed issue with removal of horizontal lines in tt_as_flextable() header when title was added.
  • Fixed multiple counts in header issue when exporting to flextable.
  • Fixed issue with empty cells "" having larger imposed margins than filled cell. They are transformed into " " before rendering.
  • Fixed issue with borders appearing in theme_docx_default() when only one line of column names is present, but top left information is on multiple lines.

Miscellaneous

  • Added option to change sep = "\t" and set other parameters via ... parameter propagation in export_as_tsv.
  • Added developer's guide vignette. New materials are focused on printing methods, specifically matrix_form and toString.
  • Grouped split functions documentation into one page with precise descriptions of each function and relative examples.
  • Moved simple_analysis into utils file.
  • Added examples to theme_docx_default() showing how to extend the default theme.
  • Added the possibility to remove internal borders from label rows in theme_html_default().
  • Split export functions into separate source files. Similarly for test files.

What's Changed

Full Changelog: v0.6.9...v0.6.10

v0.6.9 cran

27 Jun 07:48
e2a56b0
Compare
Choose a tag to compare

Miscellaneous

  • Update col_counts vignette wording, as CRAN macOS check failed. Raised the issue with the R-core team already.

What's Changed

Full Changelog: v0.6.8...v0.6.9

v0.6.8 CRAN

20 Jun 16:05
2ea0373
Compare
Choose a tag to compare

New Features

  • Add support for truetype fonts based on formatters version >= 0.5.8. Nearly all functions related to pagination or export now accept fontspec argument and pass it around accordingly, by @gmbecker.
  • Core splitting machinery can now be overridden in column space via make_split_fun provided that core_split associates the generated facets with subsetting expressions. Subsetting expressions remain unnecessary for splits in row space. By @gmbecker.
  • ValueWrapper objects now carry around subsetting expressions for use during tabulation, by @gmbecker.
  • make_split_res, add_to_split_result now accept a list of subsetting expressions which will be attached to the values, by @gmbecker.
  • New value_expr internal getter and setter methods, by @gmbecker.
  • All tables are now guaranteed to have fully path-traversable column structures (all facets in column space uniquely reachable via pathing) @gmbecker.
  • Display of higher order (non-leaf) column counts is now supported (#135) @gmbecker.
  • Column count visibility and format can be set independently for each block of sibling facets (#752) @gmbecker.
  • split_cols_by* functions now accept show_colcounts and colcount_format arguments.
  • New (column-) path based colcount_visible getter and setter for changing column count visibility in an already built table @gmbecker.
  • New (column-) path based facet_colcount getter and setter column count value at arbitrary point in column structure of built table @gmbecker.
  • New facet_colcounts_visible setter to conveniently set the column count visibility of a set of sibling facets in column space
  • New rm_all_colcounts convenience function for turning off visibility all column counts throughout the column structure @gmbecker.

Bug Fixes

  • Fixed bug in as_html preventing indentation from being applied in Viewer output.
  • col_counts<- and col_total<- methods now explicitly convert value to integer, by @gmbecker.
  • col_gap is now respected in nlines row methods, and thus by make_row_df, by @gmbecker.

Miscellaneous

  • Added lifecycle badge files for deprecated documentation.
  • Deprecated the gap and check_headers arguments to rbindl_rtables using lifecycle.

What's Changed

New Contributors

Full Changelog: v0.6.7...v0.6.8

v0.6.7 cran

15 Apr 15:05
2fa96a8
Compare
Choose a tag to compare

New Features

  • Added top_level_section_div for basic_table to set section dividers for top level rows.
  • Added keep_label_rows to as_result_df to have these lines visible.
  • sort_at_path now gives informative error messages when the given path does not exist.

Bug Fixes

  • Fixed rlistings decoration (e.g. titles and footers) expansion when there are new lines. Moved relevant handling from rtables' matrix_form function to formatters' dedicated mform_handle_newlines function.
  • Fixed issue with rtables_root not being removed when using as_result_df.
  • Fixed edge case bug in as_result_df where rows of the table have only "root" as path index.
  • Fixed sort_at_path pathing to ignore leading "root" element (regardless of actual root element name) to match current tt_at_path behavior.
  • Fixed section_div for analysis of multiple variables (AnalyzeMultiVars).
  • Fixed mismatch between indentation declared in row info (mf_rinfo(mf)) and actual selected indentation from matrix_form(mf, indent_rownames = FALSE).

Miscellaneous

  • Removed deprecated functions add_analyzed_var and trim_zero_rows.

What's Changed

New Contributors

Full Changelog: v0.6.6...v0.6.7

v0.6.6

08 Dec 11:11
f4c7da7
Compare
Choose a tag to compare

New Features

  • Removed ref_group reordering in column splits so not to change the order.
  • Added bold argument to as_html to bold specified elements, and header_sep_line
    argument to print a horizontal line under the table header in rendered HTML output.
  • Duplicate referential footnotes are consolidated when tables are rendered.
  • Section divisors can be set for analysis rows.
  • Added setter and getter for section dividers (section_div and section_div<-). They also accept
    split section structure assignment.
  • Added header_section_div setters and getters for layout and table objects along with
    related basic_table parameter.
  • Added na_str argument to analyze_colvars to set custom string to print in place of missing values.
  • Added flat data.frame outputs for as_result_df() via flag parameters as_viewer, as_strings, and
    expand_colnames.
  • Migrated export_as_pdf function to formatters.

Bug Fixes

  • Fixed a bug that was failing when wrapping and section dividers were used at the same time.
  • Fixed a bug in as_result_df causing misalignment of column names.
  • Fixed a bug that was not allowing path indexing as row_paths() was giving a different path due to it being made of
    named values.
  • Fixed a bug in as_result_df when called on tables with less than 3 rows.

Miscellaneous

  • Applied styler and resolved package lint. Changed default indentation from 4 spaces to 2.
  • Added Developer Guide to pkgdown site with Debugging, Split Machinery, and Tabulation sections.
  • Whitespace is not trimmed when rendering tables with as_html.
  • Started deprecation cycle for col_fnotes_here to be replaced with col_footnotes.
  • Exported section_div methods now have a dedicated documentation page that is visible to users.
  • When tables are exported as txt, they preserve the horizontal separator of the table.
  • Added imports on stringi and checkmate as they are fundamental packages for string handling and
    argument checking.
  • Updated introduction vignette and split it into two. Section on introspecting tables is now located in a separate vignette.

What's Changed

New Contributors

Full Changelog: v0.6.5...v0.6.6

v0.6.5

19 Oct 13:55
0abb40a
Compare
Choose a tag to compare

New Features

  • Added support for white spaces in all labels and text by redesigning of wrapping functions in formatters.
  • Added support for new line characters across rtables (titles, column names, row names, footers, and na_str).
  • Modified top left information vertical alignment to stay at the bottom of the header.

Bug Fixes

  • Fixed a bug causing Viewer and as_html to fail when new line characters were added.

Miscellaneous

  • Added slide decks for advanced training as internal files.

What's Changed

New Contributors

Full Changelog: v0.6.3...v0.6.5

v0.6.4

03 Oct 17:28
Compare
Choose a tag to compare

New Features

  • Added support for .docx exports with export_as_docx().
  • Expanded support for flextable customization with theme function specific for word documents (theme_docx_default()).

Bug Fixes

  • Fixed bug causing all-NA rows to be included in every .df_row split.

Miscellaneous

  • Specified minimal version of package dependencies.

What's Changed

New Contributors

Full Changelog: v0.6.3...v0.6.4

v0.6.3 CRAN

30 Aug 22:49
0a9e373
Compare
Choose a tag to compare

New Features

  • Analysis functions (cfun/afun) can use new parameters to extend analysis calculations: .alt_df_row and .alt_df give access to alt_counts_df across columns, while .all_col_exprs and .all_col_counts contains global information about all columns.
  • Binding objects via rbind will retain titles/footer information if identical in all objects or only present in the first object being bound.

Enhancements

  • Analysis functions (cfun/afun) have more information about current column split; .spl_context has access to cur_col_id, cur_col_expr, cur_col_split, and cur_col_split_val.
  • Added vignette on exploratory analysis with qtable.
  • Extracted qtable_layout from qtable.

Bug Fixes

  • Page-by splits which generate zero facets (and thus tables which would have zero pages when rendered) now throw an informative error at table build time.
  • Removed superfluous warning which arose for custom split functions when reference group is is set (#707 (comment)).
  • Fixed qtable labeling via row_labels (#698).
  • Error catching and test coverage for cases where alt_counts_df presents different splits from df.

Miscellaneous

  • Cleaned up spelling in documentation (#685)
  • Custom appearance vignette updated with decimal alignment support.
  • Alignment checks have been moved into formatters: formatters::check_aligns superseded internal function chk_rtables_align and formatters::list_valid_aligns superseded rtables_aligns.

What's Changed

New Contributors

  • @m7pr made their first contribution in #685

Full Changelog: v0.6.2...v0.6.3

v0.6.2

20 Jul 05:22
d294ac0
Compare
Choose a tag to compare
  • Fixed major regressions for page_by machinery caused by migration to formatters 0.5.1 pagination framework.
  • Fixed page_by labels become missing when only one level exist in the split_rows_by.
  • Fixed a bug when dropping var levels but not lblvar levels.
  • Added checks to catch bad labels (with {}) and throw informative error.
  • Added qtable function to create a table with a single top-level structure in both row and column dimensions involving faceting by 0 or more variables in each.
  • Added as_result_df function to flattern a table into a dataframe.
  • Added sanitize_table_struct, validate_table_struct, find_degen_struct to support degenerative table rendering.

What's Changed

New Contributors

  • @walkowif made their first contribution in #605
  • @Nolan-Steed made their first contribution in #677

Full Changelog: v0.6.0...v0.6.2

v0.6.1 - CRAN

19 May 23:34
fa22cac
Compare
Choose a tag to compare
  • Improved resilience of pagination machinery (paginate_table) by generalizing parameters' defaults (cpp, lpp, and font_size).
  • Moved export_as_txt to formatters. Added to reexports.
  • Migrated export_as_rtf to formatters. Not re-exported.
  • add r2rtf to Suggests
  • pagination logic has been migrated completely (excepting page_by splits) to formatters and is now invoked from there. paginate_table remains as a convenience function.
  • Removed warning in str method when called upon table objects.
  • Provide str method for VTableTree objects with a default max.level of 3, as the infinite default from base is not
    useful or informative.
  • default font_size value is now 8 across pagination and export machinery
  • margins argument in pagination and export machinery now (correctly) interpreted as inches. This change is inherited from formatters
  • lpp and cpp now default to NA_integer_, which is interpreted as inferring their value from the physical page size specified.
  • Horizontal pagination now occurs by default due to the above (because there is a default page type - "letter". Pagination can still be turned off in either direction by setting l/cpp to NULL explicitly.
  • Referential footnotes now have both a symbol and an index. Messages associated with symbols will only appear once per page in the footer materials regardless of number of elements referenced in the page with that symbol. Matches and inherits from changes in formatters
  • Started deprecation cycle for trim_zero_rows.
  • Fixed bug occurring when extracting cell_values after sorting.
  • Removed deprecated function vpaginate_table.
  • Added examples and details for sort_at_path.
  • Added split_label to function split_rows_by_multivar and extra_args to function split_cols_by_multivar.
  • Added split_rows_by_multivar documentation.

What's Changed

New Contributors

Full Changelog: v0.6.0...v0.6.1