Releases · insightsengineering/rtables (original) (raw)

v0.6.16

New Features

• Added restrict_facets function factory for use with make_split_fun
• Exportd previously internal make_subset_expr for use when constructing custom splitting behavior

What's Changed

• Update email for Abinaya Yogasekaram by @shajoezhu in #1068
• Update DESCRIPTION by @shajoezhu in #1071
• Update DESCRIPTION by @shajoezhu in #1072
• proposal for additional documentation for section dividers by @danielinteractive in #1077
• add restrict_facets and export make_subset_expr by @gmbecker in #1081
• skip vbump, v0.6.16 by @shajoezhu in #1085

Full Changelog: v0.6.15...v0.6.16

v0.6.15

v0.6.14

New Features

• Added Guided Tour section to the pkgdown site
• Added vignette: Guided Tour (Intermediate)
• Added vignette: Guided Tour (Intermediate) - Translating Shells To Layouts @gmbecker
• Added vignette: Guided Tour (Intermediate) - Identifying Required Analysis Behavior @gmbecker
• Added vignette: Guided Tour (Intermediate) - Identifying Required Faceting Behavior @gmbecker

What's Changed

• Update .revdeprefs.yaml by @shajoezhu in #1034
• Fix for upcoming testthat 3.3.0 release by @hadley in #1038
• vignette on translating shells to layouts by @gmbecker in #1044
• analysis requirement vignette by @gmbecker in #1046
• Update testthat package version requirement by @shajoezhu in #1039
• 1047 intermediate guide by @gmbecker in #1048
• update by @shajoezhu in #1049
• [skip vbump] CRAN realease v0.6.14 by @Melkiades in #1052

New Contributors

• @hadley made their first contribution in #1038

Full Changelog: v0.6.13...v0.6.14

v0.6.13

New Features

• All elements of a table's row structure are now guaranteed to be pathable. #1024 by @gmbecker
• Direct siblings anywhere in a table's tree (row) structure are now guaranteed to have unique names, with a message if de-duplication (by adding "[i]" to duplicates) was required. #1024 by @gmbecker
• Added parent_name argument to split_rows_by* and analyze* functions to manually control names of (and thus paths to) the subtables created. #1024 by @gmbecker
• Added tt_row_path_exists, which determines whether a path exists within a table's row structure, optionally restricted to resolving to a particular type of node (row, table, elementary table). #1024 by @gmbecker
• Added tt_normalize_row_path which resolves a path including the "*" wild card to all existing paths within a table, optionally restricted to resolving to a particular type. #1024 by @gmbecker
• Added documentation of basic pathing concepts (?pathing) to the man page for the above functions.
• Added new pathing vignette. @gmbecker
• When make_row_df is called on a VTableTree the returned df now includes new sect_div_from_path and self_section_div columns. #1024 by @gmbecker
• Added section_div_info convenience function which returns portions of make_row_df's result relevant to section dividers. #1024 by @gmbecker
• Added section_div_at_path and section_div_at_path<- for getting and setting section dividers for substructures within the table. The latter supports "*" wildcards for flexible usage. #1024 by @gmbecker
• Documentation regarding section dividers (?section_div) updated and expanded. #1024 by @gmbecker
• Updated as_result_df to "de-uniqify" names that were altered for pathability when determining group values in the result dataframe/ard. #1024 by @gmbecker
• Warning given when section_div<- with only_sep_sections = TRUE more values than levels of nesting present is now more informative, and occurs regardless of whether only_sep_sections was set manually or automatically (length(value) < nrow(tt)). #1024 by @gmbecker

Bug Fixes

• section_div<- now works correctly on tables that include top level siblings in their row structure (e.g., when unnested structure is added via nested = FALSE or adding a row splitting after an analyze call). #1024 by @gmbecker
• section_div<- with only_sep_sections = FALSE is now consistent regarding which value is set when analyze calls occur at different levels of nesting within the corresponding layout, particularly as top-level non-nested siblings. #1024 by @gmbecker
• section_div<- no longer sets a section div on non-visible label rows when setting a section divider for a content row on the same group. #1024 by @gmbecker
• section_div<- when given a full-length (nrow(tt)) vector now sets 'section dividers' on label rows and content rows correctly when both are visible for the same facet. #1024 by @gmbecker
• Correctly exported [ methods with signatures involving character and missing. @gmbecker
• Updated path resolution logic for [ methods to gracefully handle new sibling name de-duplication scheme. @gmbecker

Miscellaneous

• subset_cols generic and methods are now exported.
• has_force_pag generic and methods are now exported.

What's Changed

• enforce name uniqueness and pathability. unify section_div approach by @gmbecker in #1024
• export subset_cols and has_force_pag by @gmbecker in #1026
• pathing vignette. small buglet fixes by @gmbecker in #1031
• Update DESCRIPTION by @shajoezhu in #1030
• [skip vbump] v0.6.13 by @Melkiades in #1032

Full Changelog: v0.6.12...v0.6.13

v0.6.12

New Features

• Added stat_string to as_result_df(make_ard = TRUE) to preserve the original string representation of the statistics.
• Added add_tbl_name_split to as_result_df() to handle split levels constituted by different table names.
• Analysis and content functions can now accept .alt_df_full which will always be the full alt_counts_df data.frame.
• Score and pruning functions can now optionally accept additional arguments passed to sort_at_path or prune_table, score functions can also accept decreasing to receive sort order.

Bug Fixes

• Fixed issue with split_cols_by_multivar() when having more than one value. Now as_result_df(make_ard = TRUE) adds a predefined split name for each of the multivar splits.
• Fixed a bug with tt_at_path() caused by the impossibility to solve multiple branches with identical names.
• Fixed bug happening when format functions were changing the number of printed values. Now as_result_df(make_ard = TRUE) uses the cell values for stat_strings for these exceptions.
• section_div argument to analyze no longer sometimes applies dividers between each generated row in some cases. by @gmbecker
• Fixed bug in [<- causing information to be stripped from other cells if a new rcell is set within a table row.
• Fixed a bug in as_result_df(make_ard = TRUE) when different columns had different amounts of "" values.
• Fixed bug in cases where stat_name is character(0) (as_result_df(make_ard = TRUE)).
• Fixed a bug dropping information from tables when indexed with integer(), i.e. producing an empty table.

Miscellaneous

• Added handler add_tbl_str_decimals = TRUE to ... into as_result_df(make_ard = TRUE) to add stat_string column for the
  ARD output.
• As stat_string are more fragile than default as_result_df(make_ard = TRUE) calculation and are in theory optional, a warning is thrown when errors arise and the stat_string column is not added.
• Improved error messaging for cases where tt_at_path used a path based on row labels instead of row names.
• Added more informative error message when keep_split_levels() is used to keep absent values.
• Improved error message when selecting 0 columns from a table with [.
• Added safe condition for keep_split_levels() when branch is empty (character(0)).

What's Changed

• Update DESCRIPTION min xml12 by @shajoezhu in #984
• add precision column stat_string and different table names by @Melkiades in #986
• fix #992 by @shajoezhu in #993
• Fix formatted values different from cell values by @Melkiades in #988
• Remove lookup-refs by @llrs-roche in #989
• Fix [<- formatting bug by @edelarua in #997
• Update DESCRIPTION add lme4 min version by @shajoezhu in #998
• fix every row sep behavior of analyze section_div by @gmbecker in #996
• hook up round_type support by @gmbecker in #990
• fix tt_at_path and adding test coverage to error in sorting by @Melkiades in #994
• Update .revdeprefs.yaml by @shajoezhu in #1007
• Fix: more edge cases for stat_string by @Melkiades in #1003
• add support for optional .alt_df_full parameter for a/cfuns by @gmbecker in #1006
• Update DESCRIPTION fix scheduled tests by @shajoezhu in #1011
• Make sure that the generated html has borders in BS5 themed layout by @vedhav in #1014
• add ability to pass arguments to score and prune functions by @gmbecker in #1015
• keep_split_levels() correction for empty branches and more descriptive error by @Melkiades in #1017
• Update test-default_split_funs.R by @shajoezhu in #1019
• Fix subsetting by integer() and 0 by @Melkiades in #1018
• [skip vbump] Release PR v0.6.12 by @Melkiades in #1020

New Contributors

• @vedhav made their first contribution in #1014

Full Changelog: v0.6.11...v0.6.12

v0.6.11 cran

New Features

• Initialized vignette about quality control outputs of as_result_df().
• Completed parameter make_ard output for single-line statistical outputs.
• Added stat_names to rcell() to be used by as_result_df(make_ard = TRUE).

Miscellaneous

• Split docx document generation to the new package rtables.officer.
• Refactored as_result_df() parameters as_strings and as_viewer into data_format = c("full_precision", "strings", "numeric") following the same outputs.
• Refactored as_result_df() to have a standard behavior, with all the relevant parameters, and a possibility to add personalized spec.
• Removed result_df_specs(), because as_result_df() was a too shallow wrapper.
• Merged behavior of as_result_df() parameters as_is and simplify parameters to remove structural information.

Bug Fixes

• Fixed bug that was keeping indentation space characters in top left information when making a flextable from a TableTree object.
• Fixed bug in analyze that was causing an error when passing a single NA value to the
  var_labels parameter.
• Fixed bugs for multiple analyze calls in as_result_df.

What's Changed

• Pagination and column widths handling by @Melkiades in #937
• close #940 by @shajoezhu in #941
• split package by @shajoezhu in #946
• Refactor of as_result_df by @Melkiades in #954
• Correct printing output for topleft information by @Melkiades in #956
• fix: fixed an issue of a solitary NA as var_labels passed to analyze by @kpagacz in #965
• Adding stat_names and support for row/col splits and ContentRow by @Melkiades in #958
• Update DESCRIPTION, broom 1.0.5 by @shajoezhu in #969
• Fixes and testing extreme templates by @Melkiades in #968
• Check for tibble package before using it on tests by @llrs-roche in #971
• Compress logo by @llrs-roche in #972
• Replace logo.png by logo.svg by @llrs-roche in #978
• Rename logo to be displayed by @llrs-roche in #979
• preparing new release, [skip vbump] by @shajoezhu in #982

New Contributors

• @kpagacz made their first contribution in #965
• @llrs-roche made their first contribution in #971

Full Changelog: v0.6.10...v0.6.11

v0.6.10 cran

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

• Fix as_html newlines and add parameters to export_as_tsv by @Melkiades in #899
• Update ISSUE_TEMPLATE.md by @shajoezhu in #900
• Reorganize, test, and document useful split functions by @Melkiades in #905
• Workflow propagations by @walkowif in #906
• add lookup-refs param to rhub workflow by @pawelru in #907
• Dev Guide printing finalization by @Melkiades in #911
• Merge simple_analysis.R into utils.R by @edelarua in #917
• Update DESCRIPTION by @pawelru in #919
• Update DESCRIPTION by @shajoezhu in #918
• update readme by @pawelru in #920
• Fix indentation bugs and a couple of other issues by @Melkiades in #912
• update green ci by @shajoezhu in #928
• skip before require by @pawelru in #931
• Workflow propagations by @walkowif in #923
• Update DESCRIPTION, upversion formatters minimal version to 0.5.9 by @shajoezhu in #934
• bug fixes and init pagination by @Melkiades in #932
• update news and description to 0.6.10, [skip vbump] by @shajoezhu in #936

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

v0.6.9 cran

Miscellaneous

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

What's Changed

• 886 vignette hotfix by @shajoezhu in #896
• update version to 0.6.9, [skip vbump] by @shajoezhu in #897

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

v0.6.8 CRAN

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

• Fix bug removing indentation in as_html by @edelarua in #862
• Workflow propagation by @walkowif in #840
• Update contact email in CODE_OF_CONDUCT.md by @martincadek in #860
• Add lifecycle deprecation badges/warnings by @edelarua in #867
• Changes from external PR for truetype font by @gmbecker in #875
• Bumps {rmarkdown} minimal version by @averissimo in #869
• Revert spilled documentation modification by @averissimo in #882
• 872 as html fix@main by @ayogasekaram in #873
• Support display of higher-level ns by @gmbecker in #876
• update deps, [skip vbump] by @shajoezhu in #884

New Contributors

• @martincadek made their first contribution in #860

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

v0.6.7 cran

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

• Workflow propagation by @walkowif in #806
• Addition of top level divisor by @Melkiades in #796
• value_formats addition to vignette and docs by @Melkiades in #811
• Design cheatsheet by @edelarua in #807
• Moved relevant decoration expansion into formatters for rlistings fix by @Melkiades in #814
• update deps of roxygenize hook by @pawelru in #821
• Set default landing page for pkgdown docs to latest-tag by @cicdguy in #823
• Propagate files from insightsengineering/.github by @insights-engineering-bot in #824
• [skip actions] Propagate files from insightsengineering/.github by @insights-engineering-bot in #825
• fix as_result_df for nested rbind by @Melkiades in #818
• hotfix for as_result_df edge case by @Melkiades in #829
• fix sort behavior for root, add useful error, docs and tests by @gmbecker in #817
• Fix "vals" typo by @edelarua in #831
• options for strict tests; few enhancements by @pawelru in #820
• Add cheatsheet and more videos to README by @edelarua in #837
• Fix section_div in case of multiple var analyzed (AnalyzeMultiVars) by @Melkiades in #836
• fix verdepcheck by @pawelru in #841
• Clean up documentation by @edelarua in #849
• Fix row info when indentation is FALSE in matrix_form by @Melkiades in #853
• update description and news, [skip vbump] by @shajoezhu in #857

New Contributors

• @insights-engineering-bot made their first contribution in #824

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