Changelog
Source:NEWS.md
formatters 0.4.0
CRAN release: 2023-03-02
- Cell values and row labels are now word-wrapped based on column widths (
widths
intoString
andcolwidths
in pagination and exporters - New “N=xx (xx%)” format support (https://github.com/insightsengineering/rtables/issues/516)
- New generic getter and setter for na-string (
obj_na_str
andobj_na_str<-
, migrated fromrtables
) -
MatrixPrintForm
class now carries aroundhas_topleft
information explicitly, gettermf_has_topleft
- Number of header lines in a MatrixPrintForm object (
mf_nlheader
) is now a computed attribute rather than a stored one,mf_nlheader<-
has been removed - New
MatrixPrintForm
accessor:mpf_has_rlabels
determines whether the MPF$strings has a column which are label rows (i.e. no column index in originating object). -
wrap_text
andwrap_string
now accept thehard
argument (defaultFALSE
) indicating whether ‘hard’ word-wrapping (i.e. explicit embedding of newline characters) should be performed. -
vert_pag_indices
now acceptsrep_cols
to control how many columns act as ‘row-label-like’, as required byrlistings
- Documentation of pagination algorithm greatly expanded.
- Pagination with
verbose = TRUE
is now significnatly more informative - fix bug where indenting was not correct when row-labels were word wrapped (#84, #85)
- fix bug where portions of table after last section div (e.g., non-nested further analyses) were omitted (#77)
- fix bug in
mf_rinfo<-
checked the new value against the wrong dimensions. - Fixed off-by-one error in basic pagination machinery
- Fix bug in position of header separator when columns have word wrapping (#68)
- Bug rendering
mf_lgrouping
non-functional has been fixed
formatters 0.3.4
-
nlines
now accepts bothcolwidths
andmax_width
, defaulting toNULL
for both -
pag_indices_inner
,find_pag
andvalid_pag
now accepthave_col_fnotes
anddiv_height
arguments - fix bug which lead to insightsengineering/rtables#414 (
nlines("", <non-null>)
threw an error - paginate related generics now accept max_width for use in ensuring pagination now takes word wrapping into account for titles and footers.
- nlines character method has changed, not takes the sum of the nlines of its elements instead of the max in the case of a vector of length > 1
- new
wrap_title_footer
function for use on everything which implements the generic interface we design. - export new
page_dim
function which returns values of page dims for a named type. -
tf_wrap
functionality now breaks up words that are too large with respect to surrounding word wrapping. -
tf_wrap
behavior no longer emits a warning when breaking up ‘words’ larger thanmax_width
-
tf_wrap
max_width = "auto"
now sets themax_width
tosum(widths) + table_inset(x)
instead ofsum(widths)
- Experimental
tf_wrap
functionality added totoString
MatrixPrintForm
method -
MatrixPrintForm
class now includes atable_inset
element - Add
table_inset
andtable_inset<-
generics now exported -
toString
now respectstable_inset
values set on aMatrixPrintForm
object - Use
exact=TRUE
for all calls toattr
in accessor functions. - length-zero values of
na_str
are now silently interpreted as the default value ("NA"
), as are any missing values inna_str
of length > 0. - adding wrapping of titles, subtitles, and footers.
-
page_lcpp
function now provided to map page size and font combinations to lines and characters per page. - getters and setters for the components of
MatrixPrintForm
objects are now exported (i.e.,mf_spans
and friends). -
na_str
can now be length >1, and is matched in position to NAs in that case. -
format_value
now returns solely thena_str
value when all-NA values are formatted with certain formats (currently"(N=xx)"
,">999.9"
,">999.99"
,"x.xxxx | (<0.0001)"
)
formatters 0.3.2.5
-
label_vars<-
now correctly adheres to names of value, even in different order thannames(x)
. Fixes rlistings#8
formatters 0.3.2.3
- fix regression caused by
0.3.2.2
invert_pag_indices
whenobj
is not aMatrixPrintForm
object
formatters 0.3.2.2
- Added support for
trailing_sep
column to row_info data.frames (e.g,pagdfrow
constructor) -
trailing_sep
info now used in both printing and pagination -
col_gap
is now an element ofMatrixPrintForm
objects -
vert_pag_indices
fixed to correctly take gap between printed columns into account
formatters 0.3.2.1
- calling
var_labels
on a data.frame with no columns is no longer an error (insightsengineering/rtables#224)
formatters 0.3.2
CRAN release: 2022-06-09
- Change warning when non-UTF line sep default is used to message, and display it only during interactive sessions (once per session).
formatters 0.3.0
- add exported
default_hsep
function for use her and in reverse-dependencies (inclrtables
) - format_value now respects
na_str
even when format isxx
(previously it returned"NA"
always) - rename
linesep
argument tohsep
intoString
generic signature - add
indent_size
argument tomatrix_form
generic signature - add a number of
"__ (__)"
(no pct) formats in response to #23 - Switch to
testthat
as testing framework