Releases: insightsengineering/rtables
Releases · insightsengineering/rtables
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
tott_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 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_titles
tott_to_flextable()
to bold titles.
Bug Fixes
- Fixed
"\n"
newline issues inas_html
by relying onto output devices for newline handling. Addedexpand_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 inexport_as_tsv
. - Added developer's guide vignette. New materials are focused on printing methods, specifically
matrix_form
andtoString
. - 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 toexport_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 onformatters
version>= 0.5.8
. Nearly all functions related to pagination or export now acceptfontspec
argument and pass it around accordingly, by @gmbecker. - Core splitting machinery can now be overridden in column space via
make_split_fun
provided thatcore_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 acceptshow_colcounts
andcolcount_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 inViewer
output. col_counts<-
andcol_total<-
methods now explicitly convertvalue
to integer, by @gmbecker.col_gap
is now respected innlines
row methods, and thus bymake_row_df
, by @gmbecker.
Miscellaneous
- Added
lifecycle
badge files for deprecated documentation. - Deprecated the
gap
andcheck_headers
arguments torbindl_rtables
usinglifecycle
.
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
forbasic_table
to set section dividers for top level rows. - Added
keep_label_rows
toas_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 fromrtables
'matrix_form
function toformatters
' dedicatedmform_handle_newlines
function. - Fixed issue with
rtables_root
not being removed when usingas_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 currenttt_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 frommatrix_form(mf, indent_rownames = FALSE)
.
Miscellaneous
- Removed deprecated functions
add_analyzed_var
andtrim_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 nestedrbind
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
inmatrix_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
v0.6.6
New Features
- Removed
ref_group
reordering in column splits so not to change the order. - Added
bold
argument toas_html
to 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_div
andsection_div<-
). They also accept
split section structure assignment. - Added
header_section_div
setters and getters for layout and table objects along with
relatedbasic_table
parameter. - Added
na_str
argument toanalyze_colvars
to set custom string to print in place of missing values. - Added flat
data.frame
outputs foras_result_df()
via flag parametersas_viewer
,as_strings
, and
expand_colnames
. - Migrated
export_as_pdf
function 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_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 withcol_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
andcheckmate
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
- 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
hsep
propagation fix by @Melkiades in #789- Add
na_str
argument toanalyze_colvars
by @edelarua in #791 - Fix column name misalignment bug in
as_result_df
by @edelarua in #792 - Direct formatted output from
as_result_df
by @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.md
file by @edelarua in #799 - migrate export_as_pdf by @ayogasekaram in #798
- Fix
as_result_df
bug 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
v0.6.5
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
andas_html
to fail when new line characters were added.
Miscellaneous
- Added slide decks for advanced training as internal files.
What's Changed
- Adds min package version by @averissimo in #693
- Prototypes for docx by @Melkiades in #719
- Fix bug causing all-
NA
rows to be included in all.df_row
splits by @edelarua in #739 - [skip vbump] Release v0.6.4 by @Melkiades in #740
- Adapting to formatters changes to allow whitespaces by @Melkiades in #741
- Fixing Viewer and as_html for \n manual varlabels by @Melkiades in #742
- Update read me with training part 2 slides by @ayogasekaram in #743
- Add tests@208 support for newline@main by @Melkiades in #746
- adding newlines support for footers and titles by @Melkiades in #751
- Fix integration for version 6.4 by @Melkiades in #754
New Contributors
- @averissimo made their first contribution in #693
Full Changelog: v0.6.3...v0.6.5
v0.6.4
New Features
- Added support for
.docx
exports withexport_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
- Adds min package version by @averissimo in #693
- Prototypes for docx by @Melkiades in #719
- Fix bug causing all-
NA
rows to be included in all.df_row
splits by @edelarua in #739
New Contributors
- @averissimo made their first contribution in #693
Full Changelog: v0.6.3...v0.6.4
v0.6.3 CRAN
New Features
- Analysis functions (
cfun/afun
) can use new parameters to extend analysis calculations:.alt_df_row
and.alt_df
give access toalt_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 tocur_col_id
,cur_col_expr
,cur_col_split
, andcur_col_split_val
. - Added vignette on exploratory analysis with
qtable
. - Extracted
qtable_layout
fromqtable
.
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 viarow_labels
(#698). - Error catching and test coverage for cases where
alt_counts_df
presents different splits fromdf
.
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 functionchk_rtables_align
andformatters::list_valid_aligns
supersededrtables_aligns
.
What's Changed
- reduce the amount of spelling issues / WORDLIST by @m7pr in #685
- Fixes to various row_labels situations with tests. by @gmbecker in #700
- adding col split names and paths clearly to
.spl_context
by @Melkiades in #665 - Error at table build time when page-by splits generate zero facets. by @gmbecker in #712
- Integrate support for decimal alignment tests by @Melkiades in #680
- 707 squash bad warning by @gmbecker in #718
- Minor docs update for qtable. by @anajens in #714
- Keep annotations when rbinding two tables by @edelarua in #602
- Close #695: Add qtable vignette. by @anajens in #697
- linking main_footer documentation from formatters. by @ayogasekaram in #724
- Organize vignettes, update site template by @edelarua in #725
- Catching errors for mismatches in alt_counts_df splits by @Melkiades in #721
- vbump 0.6.3, [skip vbump] by @shajoezhu in #726
New Contributors
Full Changelog: v0.6.2...v0.6.3
v0.6.2
- Fixed major regressions for
page_by
machinery caused by migration toformatters
0.5.1 pagination framework. - Fixed
page_by
labels become missing when only one level exist in thesplit_rows_by
. - Fixed a bug when dropping
var
levels but notlblvar
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
- bump devel version by @gmbecker in #564
- Add
split_rows_by_multivar
documentation by @edelarua in #573 - Add split_label to rows_by_multivar, extra_args to both multivar by @gmbecker in #576
- Fix bad badge by @cicdguy in #578
sort_at_path
example and details by @Melkiades in #560- Remove deprecated function
vpaginate_table
by @edelarua in #586 - Connect
custom_split_funs
documentation by @edelarua in #584 - Fix bug in
sort_at_path
by @edelarua in #589 - add regression test for fix to #588 by @gmbecker in #590
- Start deprecation cycle for
trim_zero_rows
by @edelarua in #585 - Adding gitlab pipeline by @arkadiuszbeer in #592
- Add tests for
count_wpcts
by @edelarua in #593 - Add test for
spl_variable
by @edelarua in #595 - Add test for
export_as_rtf
by @edelarua in #594 - Add a releaser workflow by @cicdguy in #601
- Workflow updates by @walkowif in #605
- Fix CRAN oldrel windows failure by changing tests by @gmbecker in #609
- Fix various issues for the str method for VTableTree by @gmbecker in #615
- fixing vbump for tern by @Melkiades in #619
- Automated version bumping by @cicdguy in #621
- Update token name by @walkowif in #626
- Fixes for exporter pagination migration by @Melkiades in #631
- Drafing NEWS file by @Melkiades in #639
- Fix font_size default. add r2rtf to Suggests. vbump. NEWS by @gmbecker in #641
- Release v0.6.1 [skip vbump] by @edelarua in #642
- fix major regressions in page_by functionality with new pag machinery by @gmbecker in #644
- Update workflows by @walkowif in #649
- add qtable and as_ard with experimental ard generation spec by @gmbecker in #648
- Remove JunitReporter by @pawelru in #652
- Change default landing page to latest-release by @walkowif in #658
- table structure validation POC by @gmbecker in #659
- Mark structure validation funcs as experimental to allow future changes by @gmbecker in #662
- Workflow propagations by @walkowif in #667
- propagate rd changes inherited from formatters by @gmbecker in #675
- catch bad labels (with {}) and throw informative error by @gmbecker in #673
- Fix #657 and bug when dropping var levels but not lblvar levels by @gmbecker in #674
- Add vignette for cox regression analysis function by @edelarua in #617
- Fix R CMD CHECK note by @edelarua in #683
- Add tests for
export_as_txt
split level labels usingpage_by
by @edelarua in #681 - 670 rename as ard 2@main by @Nolan-Steed in #677
- vbump to 0.6.2, update description and news. [skip vbump] by @shajoezhu in #692
New Contributors
Full Changelog: v0.6.0...v0.6.2
v0.6.1 - CRAN
- Improved resilience of pagination machinery (
paginate_table
) by generalizing parameters' defaults (cpp
,lpp
, andfont_size
). - Moved
export_as_txt
toformatters
. Added to reexports. - Migrated
export_as_rtf
toformatters
. 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 forVTableTree
objects with a defaultmax.level
of 3, as the infinite default from base is not
useful or informative. - default
font_size
value is now8
across pagination and export machinery margins
argument in pagination and export machinery now (correctly) interpreted as inches. This change is inherited fromformatters
lpp
andcpp
now default toNA_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 settingl/cpp
toNULL
explicitly. - Referential footnotes now have both a
symbol
and anindex
. 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 informatters
- 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 functionsplit_rows_by_multivar
andextra_args
to functionsplit_cols_by_multivar
. - Added
split_rows_by_multivar
documentation.
What's Changed
- bump devel version by @gmbecker in #564
- Add
split_rows_by_multivar
documentation by @edelarua in #573 - Add split_label to rows_by_multivar, extra_args to both multivar by @gmbecker in #576
- Fix bad badge by @cicdguy in #578
sort_at_path
example and details by @Melkiades in #560- Remove deprecated function
vpaginate_table
by @edelarua in #586 - Connect
custom_split_funs
documentation by @edelarua in #584 - Fix bug in
sort_at_path
by @edelarua in #589 - add regression test for fix to #588 by @gmbecker in #590
- Start deprecation cycle for
trim_zero_rows
by @edelarua in #585 - Adding gitlab pipeline by @arkadiuszbeer in #592
- Add tests for
count_wpcts
by @edelarua in #593 - Add test for
spl_variable
by @edelarua in #595 - Add test for
export_as_rtf
by @edelarua in #594 - Add a releaser workflow by @cicdguy in #601
- Workflow updates by @walkowif in #605
- Fix CRAN oldrel windows failure by changing tests by @gmbecker in #609
- Fix various issues for the str method for VTableTree by @gmbecker in #615
- fixing vbump for tern by @Melkiades in #619
- Automated version bumping by @cicdguy in #621
- Update token name by @walkowif in #626
- Fixes for exporter pagination migration by @Melkiades in #631
- Drafing NEWS file by @Melkiades in #639
- Fix font_size default. add r2rtf to Suggests. vbump. NEWS by @gmbecker in #641
New Contributors
Full Changelog: v0.6.0...v0.6.1