Releases: insightsengineering/rtables
Releases · insightsengineering/rtables
v0.6.15
New Features
- Allow table objects to have
round_typeinstead of needing to specify on export #1040 - New
obj_round_typegetter and setter methods.
What's Changed
- addresses #1056 by @eanokian in #1057
- Change htmltools version from 0.5.4 to 0.5.8.1 by @shajoezhu in #1060
- 1040 rtables round type by @iaugusty in #1062
- fix candidate for 1058 by @gmbecker in #1063
- 1041 formats var by @gmbecker in #1064
- prep for release v0.6.15 [skip vbump] by @shajoezhu in #1067
New Contributors
Full Changelog: v0.6.14...v0.6.15
v0.6.14
New Features
- Added Guided Tour section to the
pkgdownsite - 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
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_nameargument tosplit_rows_by*andanalyze*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_pathwhich 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
pathingvignette. @gmbecker - When
make_row_dfis called on aVTableTreethe returned df now includes newsect_div_from_pathandself_section_divcolumns. #1024 by @gmbecker - Added
section_div_infoconvenience function which returns portions ofmake_row_df's result relevant to section dividers. #1024 by @gmbecker - Added
section_div_at_pathandsection_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_dfto "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<-withonly_sep_sections = TRUEmore values than levels of nesting present is now more informative, and occurs regardless of whetheronly_sep_sectionswas 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 vianested = FALSEor adding a row splitting after ananalyzecall). #1024 by @gmbeckersection_div<-withonly_sep_sections = FALSEis now consistent regarding which value is set whenanalyzecalls occur at different levels of nesting within the corresponding layout, particularly as top-level non-nested siblings. #1024 by @gmbeckersection_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 @gmbeckersection_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 involvingcharacterandmissing. @gmbecker - Updated path resolution logic for
[methods to gracefully handle new sibling name de-duplication scheme. @gmbecker
Miscellaneous
subset_colsgeneric and methods are now exported.has_force_paggeneric 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_stringtoas_result_df(make_ard = TRUE)to preserve the original string representation of the statistics. - Added
add_tbl_name_splittoas_result_df()to handle split levels constituted by different table names. - Analysis and content functions can now accept
.alt_df_fullwhich will always be the fullalt_counts_dfdata.frame. - Score and pruning functions can now optionally accept additional arguments passed to
sort_at_pathorprune_table, score functions can also acceptdecreasingto receive sort order.
Bug Fixes
- Fixed issue with
split_cols_by_multivar()when having more than one value. Nowas_result_df(make_ard = TRUE)adds a predefined split name for each of themultivarsplits. - 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 forstat_stringsfor these exceptions. section_divargument toanalyzeno 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 newrcellis 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_nameischaracter(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 = TRUEto...intoas_result_df(make_ard = TRUE)to addstat_stringcolumn for the
ARDoutput. - As
stat_stringare more fragile than defaultas_result_df(make_ard = TRUE)calculation and are in theory optional, a warning is thrown when errors arise and thestat_stringcolumn is not added. - Improved error messaging for cases where
tt_at_pathused 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_stringand 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_pathand adding test coverage to error in sorting by @Melkiades in #994 - Update .revdeprefs.yaml by @shajoezhu in #1007
- Fix: more edge cases for
stat_stringby @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()and0by @Melkiades in #1018 - [skip vbump] Release PR v0.6.12 by @Melkiades in #1020
New Contributors
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_ardoutput for single-line statistical outputs. - Added
stat_namestorcell()to be used byas_result_df(make_ard = TRUE).
Miscellaneous
- Split
docxdocument generation to the new packagertables.officer. - Refactored
as_result_df()parametersas_stringsandas_viewerintodata_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 personalizedspec. - Removed
result_df_specs(), becauseas_result_df()was a too shallow wrapper. - Merged behavior of
as_result_df()parametersas_isandsimplifyparameters to remove structural information.
Bug Fixes
- Fixed bug that was keeping indentation space characters in top left information when making a
flextablefrom aTableTreeobject. - Fixed bug in
analyzethat was causing an error when passing a singleNAvalue to the
var_labelsparameter. - Fixed bugs for multiple
analyzecalls inas_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_dfby @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
ContentRowby @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
.htmloutputs. - Added parameter
bold_titlestott_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
ttinput fromtheme_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_titlestott_to_flextable()to bold titles.
Bug Fixes
- Fixed
"\n"newline issues inas_htmlby relying onto output devices for newline handling. Addedexpand_newlines = FALSEdefault 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 inexport_as_tsv. - Added developer's guide vignette. New materials are focused on printing methods, specifically
matrix_formandtoString. - Grouped split functions documentation into one page with precise descriptions of each function and relative examples.
- Moved
simple_analysisinto 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_htmlnewlines and add parameters toexport_as_tsvby @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_countsvignette 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
truetypefonts based onformattersversion>= 0.5.8. Nearly all functions related to pagination or export now acceptfontspecargument and pass it around accordingly, by @gmbecker. - Core splitting machinery can now be overridden in column space via
make_split_funprovided thatcore_splitassociates 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_resultnow accept a list of subsetting expressions which will be attached to the values, by @gmbecker.- New
value_exprinternal 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 acceptshow_colcountsandcolcount_formatarguments.- New (column-) path based
colcount_visiblegetter and setter for changing column count visibility in an already built table @gmbecker. - New (column-) path based
facet_colcountgetter and setter column count value at arbitrary point in column structure of built table @gmbecker. - New
facet_colcounts_visiblesetter to conveniently set the column count visibility of a set of sibling facets in column space - New
rm_all_colcountsconvenience function for turning off visibility all column counts throughout the column structure @gmbecker.
Bug Fixes
- Fixed bug in
as_htmlpreventing indentation from being applied inVieweroutput. col_counts<-andcol_total<-methods now explicitly convertvalueto integer, by @gmbecker.col_gapis now respected innlinesrow methods, and thus bymake_row_df, by @gmbecker.
Miscellaneous
- Added
lifecyclebadge files for deprecated documentation. - Deprecated the
gapandcheck_headersarguments torbindl_rtablesusinglifecycle.
What's Changed
- Fix bug removing indentation in
as_htmlby @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_divforbasic_tableto set section dividers for top level rows. - Added
keep_label_rowstoas_result_dfto have these lines visible. sort_at_pathnow gives informative error messages when the given path does not exist.
Bug Fixes
- Fixed
rlistingsdecoration (e.g. titles and footers) expansion when there are new lines. Moved relevant handling fromrtables'matrix_formfunction toformatters' dedicatedmform_handle_newlinesfunction. - Fixed issue with
rtables_rootnot being removed when usingas_result_df. - Fixed edge case bug in
as_result_dfwhere rows of the table have only"root"as path index. - Fixed
sort_at_pathpathing to ignore leading"root"element (regardless of actual root element name) to match currenttt_at_pathbehavior. - Fixed
section_divfor analysis of multiple variables (AnalyzeMultiVars). - Fixed mismatch between indentation declared in row info (
mf_rinfo(mf)) and actual selected indentation frommatrix_form(mf, indent_rownames = FALSE).
Miscellaneous
- Removed deprecated functions
add_analyzed_varandtrim_zero_rows.
What's Changed
- Workflow propagation by @walkowif in #806
- Addition of top level divisor by @Melkiades in #796
value_formatsaddition 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-tagby @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_dffor nestedrbindby @Melkiades in #818 - hotfix for
as_result_dfedge 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_divin 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
FALSEinmatrix_formby @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
v0.6.6
New Features
- Removed
ref_groupreordering in column splits so not to change the order. - Added
boldargument toas_htmlto bold specified elements, andheader_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_divandsection_div<-). They also accept
split section structure assignment. - Added
header_section_divsetters and getters for layout and table objects along with
relatedbasic_tableparameter. - Added
na_strargument toanalyze_colvarsto set custom string to print in place of missing values. - Added flat
data.frameoutputs foras_result_df()via flag parametersas_viewer,as_strings, and
expand_colnames. - Migrated
export_as_pdffunction toformatters.
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_dfcausing 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_dfwhen called on tables with less than 3 rows.
Miscellaneous
- Applied
stylerand 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_hereto be replaced withcol_footnotes. - Exported
section_divmethods 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
stringiandcheckmateas 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
- Update logo by @edelarua in #756
- Remove old references by @cicdguy in #757
- Apply styler, fix lint by @edelarua in #760
- moving training slides to repo subdir by @ayogasekaram in #764
- update ref_group column ordering by @clarkliming in #748
- Split Machinery and Tabulation - Dev Guide by @Melkiades in #614
- Add developer guide to pkgdown site by @edelarua in #744
- Render the dev-guide as part of pkgdown by @cicdguy in #771
- Add favicon to pkgdown site by @edelarua in #770
- Fix bug when footnote path contains named elements by @edelarua in #772
- Keep whitespace in html tables by @edelarua in #777
- Align table html output with ASCII output by @edelarua in #780
- Combine duplicate ref footnotes by @edelarua in #781
- 761 better getter seeters@221 fix separator div@main by @Melkiades in #782
hseppropagation fix by @Melkiades in #789- Add
na_strargument toanalyze_colvarsby @edelarua in #791 - Fix column name misalignment bug in
as_result_dfby @edelarua in #792 - Direct formatted output from
as_result_dfby @Melkiades in #793 - Fix potential tt at path issue by @clarkliming in #794
- avoid pipe and dot; add note blocklist by @pawelru in #797
- Add
CONTRIBUTING.mdfile by @edelarua in #799 - migrate export_as_pdf by @ayogasekaram in #798
- Fix
as_result_dfbug for small tables by @edelarua in #801 - Update introduction vignette by @anajens in #716
- class hierarchy document by @ayogasekaram in #637
- init update for cran release prep 0.6.6, [skip vbump] by @shajoezhu in #804
New Contributors
- @clarkliming made their first contribution in #748
Full Changelog: v0.6.5...v0.6.6