gtsummary 1.3.2 2020-06-14

  • Now returning all columns from broom::tidy() in .$table_body() (#516)

  • tbl_stack() now accepts a named list of gtsummary tables when using the group_header= argument (#524)

  • add_p.tbl_summary() bug fix for Wilcoxon rank-sum p-value calculation introduced in the last release (#525)

  • Delaying the release of as_huxtable() until the next {huxtable} release.

gtsummary 1.3.1 2020-06-02

New Functions

  • Introducing themes in {gtsummary}. Use the function set_gtsummary_theme() to set new themes, and review the themes vignette for details on setting and creating personalized themes. (#424)

  • New functions modify_footnote() and modify_spanning_header() give users control over table footnotes and spanning headers. (#464)

  • Introducing as_huxtable()! The function converts gtsummary objects to {huxtable} objects. {huxtable} supports indentation, footnotes, and spanning headers with Word, HTML, and PDF output. (#469)

  • New function add_stat()! Add a new column of any statistic to a tbl_summary() table (#495)

User-facing Updates

  • The following columns in tbl_summary() are now available to print for both continuous and categorical variables: total number of observations {N_obs}, number of missing observations {N_miss}, number of non-missing observations {N_nomiss}, proportion of missing observations {p_miss}, proportion of non-missing observations {p_nomiss}. (#473)

  • Improved appearance of default as_flextable() output (#499)

  • Added tbl_cross(margin=) argument to control which margins are shown in the output table. (#444)

  • The missing values are now included in the calculation of p-values in tbl_cross().

  • Messaging about statistical methods used has been added for add_global_p(), add_q(), and combine_terms(). (#471)

  • Added include= argument to tbl_summary(). The preferred syntax for p-values with correlated data is now tbl_summary(..., include = -group_var) %>% add_p(group = group_var). The group variable is now no longer removed from the table summary. (#477)

  • add_stat_label() function updated with location= and label= arguments to change the location of the statistic labels and to modify the text of the labels. location = "row" is now the default. (#467)

  • tbl_stack() function added the group_header= argument that groups the stacked tables and adds a horizontal header row between them. (#468)

  • Updated handling for interaction terms in tbl_regression(). Interaction terms may now be specified in the show_single_row= and label= arguments. (#451, #452)

Internal Updates

  • Improved error messaging when invalid statistics are requested in tbl_summary(statistic=) (#502)

  • All columns in as_tibble() are now styled and converted to character. Previously, styling was applied to most columns, but there were a few that relied on default printing for the type of underlying data. This was ok to rely on this default behavior for as_kable(), but with the introduction of as_flextable() we needed to style and format each column to character. Potential to break some code in edge cases. (#493)

  • Handling of passed custom p-value functions in add_p.tbl_summary() has been improved with more careful handling of the environments from which the functions were passed. Other related updates were also made:

    • Users may pass their custom p-value function as a quoted string or bare.
    • The basic functions for calculating p-values, such as t.test() can now be passed directly e.g. test = age ~ t.test. We now perform a check match check for functions passed. If it is passed, we replace it with our internal version that returns the p-value and assigns the test name.
    • If a user passes a custom function, and it’s not the proper form (i.e. a named list return object) AND the function returns a single numeric value, we assume that is the p-value and it’s added to the gtsummary table.
  • Updated the gtsummary core script, utils-gtsummary_core.R, to refer to all non-base R functions with the pkg:: prefix, so other packages that copy the file don’t need to import the same functions as {gtsummary} in the NAMESPACE. Now they just need to depend on the same packages. (#454)

Bug Fixes

  • Bug fix for inline_text.tbl_summary() when categorical variable contained levels with empty strings. There is still an issue if a user tries to select the empty string, however.

  • Fixed bug where some variables in tbl_cross() defaulted to dichotomous instead of showing as categorical (#506)

  • Bug fix when using a tbl_summary(by=) with missing observations in by= followed by add_overall()

  • Bug fix where values ">0.9" were incorrectly made bold using bold_p(). (#489)

  • Bug fix for as_flextable(). (#482)

    • Added a formatting function to all numeric columns to force conversion to character.
    • Spanning headers were being printed in alphabetical order! Update to preserve the ordering.

gtsummary 1.3.0 2020-04-17

New Functions

  • Introducing tbl_cross(), add_p.tbl_cross(), and inline_text.tbl_cross()! Easily construct cross tabulations of two variables.

  • Introducing tbl_survfit() and inline_text.tbl_survfit()! These will eventually replace tbl_survival(), which will no longer be encouraged. The new functions follow the structural guidelines of a {gtsummary} object and can be merged and stacked with any other {gtsummary} object (#280)

  • Introducing as_flextable()! The function converts gtsummary objects to {flextable} objects. {flextable} is a great option when using R markdown with Microsoft Word output. {flextable} supports indentation, footnotes, and spanning headers with Word, HTML, and PDF output.

  • Introducing as_kable_extra()! The function converts gtsummary objects to {kableExtra} objects. {kableExtra} supports indentation, footnotes, and spanning headers with HTML and PDF output. (#394)

User-facing Updates

  • Updated default print engine for {gtsummary} objects. {gt} is the default printer for the R console and R markdown documents with HTML output. PDF, RTF, and Word output default to using {kable} with a note referring users to a new vignette explaining why {gt} was not used. (#395, #396)

  • Updated add_p() custom p-value description to NOT require double escape characters for quotation marks (#361)

  • Created structure and enumerated list of unit tests each vetted model must pass, and added the tests (#383)

Internal Updates

  • Each gtsummary object has an associated .$table_header. The code needed to print a table with either gt or kable was previously a mix of information stored in the table_header, and code manually added to the gt_calls or kable_calls object. Now, all the information needed to print a table is stored in table_header. This has the advantage that any updates to the printing will now require an update to table_header only, and we no longer need to update the tibble, kable and gt calls. (#412, #414)

  • The {gt} package is now released on CRAN, and we’ve updated to depend on the CRAN version instead of the version on GitHub. This also resulted in significant updates throughout the documentation and code. For example, we no longer provide instructions for installing {gt}, or include internal checks if {gt} is installed. (#420)

  • Several functions have been made general, and may now be applied to any {gtsummary}-like object. Functions updated are add_q(), bold_p(), sort_p(), tbl_merge(), tbl_stack(), bold_labels(), bold_levels(), italicize_labels(), and italicize_levels(). (#434, #429, #373)

  • In tbl_regression() we previously printed the estimate, confidence interval, and p-value for all models. But some models don’t have associated methods for calculating the p-value or the confidence intervals. In this update, we now print the p-value if tidy() returns a "p.value" column. Similarly, the confidence interval is printed if tidy() returns "conf.low" and "conf.high" columns. (#391, #404)

Bug Fixes

  • Bug fix when data frame passed to tbl_summary() with a single column (#389)

  • In tbl_summary() passing an ordered factor in the by= argument no longer causes as error. (#453)

gtsummary 1.2.6 2020-02-13

  • Bug fix for random effects regression model where coefficients were not exponentiated when requested. Using broom.mixed::tidy() rather than broom::tidy() resolved issue.

gtsummary 1.2.5 2020-02-11

Documentation

  • Updated documentation and README to improve readability, added more cross-linking across pages, added search terms to help users find our package, and added gif demonstrations (#340)

  • README images now build differently for website vs GitHub markdown to accommodate different output formats

Breaking changes

  • Removed deprecated fmt*_() and cols_label_summary() functions (#365)

  • Functions tbl_summary_() and add_p_() have been deprecated because the by= and group= arguments now accept strings (#250)

Syntax

  • Package-wide update allowing arguments that accept variable names to accept bare/symbol inputs, character inputs, stored character inputs, and tidyselect helpers. When passing a single variable, the vars() function wrapper is no longer required. (#250)

    tbl_summary(trial, label = age ~ "NEW LABEL"))
    tbl_summary(trial, label = "age" ~ "NEW LABEL"))
    tbl_summary(trial, label = c("age", "trt") ~ "NEW LABEL"))
    tbl_summary(trial, label = c(age, trt) ~ "NEW LABEL"))
    tbl_summary(trial, label = vars(age, trt) ~ "NEW LABEL"))
    tbl_summary(trial, label = vars(everything(), -age, -trt) ~ "NEW LABEL"))
    
    age_column = "age"
    tbl_summary(trial, label = age_column ~ "NEW LABEL"))
    tbl_summary(trial, label = vars(age_column) ~ "NEW LABEL")
    
    purrr::map(c("trt", "grade"), ~tbl_summary(trial, by = .x))
  • Updated tbl_uvregression() to allow flexible tidyselect inputs and improved error messaging for arguments x and y (#249)

  • After the input updates in #250, the exclude= argument appearing in add_p(), tbl_regression(), tbl_uvregression(), as_gt(), as_kable(), and as_tibble() was redundant. The exclude= argument is now deprecated. Use include= instead, with tidyselect syntax. (#331)

  • Functions all_categorical(), all_dichotomous(), and all_continuous() may now be used in tbl_summary() argument type= (#256)

User-facing improvements

  • New pattern= argument in inline_text.tbl_summary(). Previously, we could only grab the entire cell from a tbl_summary() with inline_text(), and now we can get any single statistic reported (#254)

  • Improved messaging for users who use knitr::kable() to print gtsummary tables, and users who have not yet installed the {gt} package (#347)

  • New function combine_terms() allows users to combine multiple independent variables in a regression model into a single line after tbl_regression(). The single line does not report regression coefficients, rather a single p-value from the anova() function. (#310)

  • In the regression modeling functions tbl_regression() and tbl_uvregression(), the users are presented an informative error message when the tidier fails (e.g. broom::tidy()) alerting them to the location of the error so they may address the issue (#337, #338)

  • For each release of gtsummary, we now can make reference to the version of gt our release coincides with. The commit SHA for gt is now saved in an object called gt_sha, and the version of gt can be installed with remotes::install_github("rstudio/gt", ref = gt_sha) (#329)

  • Created “style” family of functions

  • Improved error messaging in tidyselect_to_list() (#300)

Other features and fixes

  • Updated class detection to use inherits(), and added secondary class of "gtsummary" to all objects. This allows users to create their own cobbled/custom gtsummary objects while utilizing the gtsummary print functions (#249)

  • tbl_summary() will now summarize columns of class difftime (#343)

  • Infrastructure update to the way styling/formatting functions are returned. Styling functions are now returned as a column in the .$table_header tibble. The update simplifies handling of these styling functions in tbl_merge() and tbl_stack(). (#298, #299)

  • Bug fix for tbl_summary() when variables were all NA (#344)

  • The data summary function add_p() now uses probabilities rather than counts to calculate expected cell counts to avoid an error when working with large data sets. (#341)

  • Cubic spline terms are now accurately matched to a variable name/term (#312)

  • Bug fix when non-standard evaluation arguments were passed in method.args= argument of tbl_uvregression() (#322)

  • Updates after the gt package deprecated gt::cells_data() in favor of gt::cells_body(). Check added to as_gt() ensuring a version of gt with gt::cells_body() in its NAMESPACE

  • Lowered minimum required version of R to v3.4 (#356)

  • Removed {broom.mixed} dependency as the {broom} package contained all necessary tidiers (#354)

gtsummary 1.2.4 2019-12-16

  • Bug fix in as_kable() where column header did not match statistics presented when certain levels of the by= variable are entirely missing in tbl_summary() (#304)

  • Updated the trial example data set "trt" variable to be "Drug A" and "Drug B" instead of "Placebo" and "Drug"

  • Improved messaging to users when an error or warning occurs while calculating a p-value in add_p(). Also, p-values are no longer omitted from output when a warning is encountered during their calculation (#283)

  • Added tidy_fun= argument to tbl_regression() and tbl_uvregression() allowing users to pass tidiers that are not in the {broom} and {broom.mixed} packages (#247)

gtsummary 1.2.3 2019-11-12

  • tbl_uvregression() now accepts an x= argument to build univariate regression models where the covariate x remains the same while models are built the with remaining variables as the outcome (#294)

  • Internal updates to the way {gt} is installed during CRAN checks.

  • Bug fix when stacking tbl_summary objects with calculated p-values.

gtsummary 1.2.2 2019-11-10

New Features

  • tbl_summary objects may be stacked and merged with tbl_stack() and tbl_merge() (#230, #255)

  • The add_n() function now reports additional statistics: total N, non-missing N, missing N, and their percentages. The missing = argument has been deprecated in favor of the statistic = argument. (#237)

  • Users may now pass a list of formulas, named lists, or a combination of both (#251)

  • Users can add an option to their script to append any {gt} calls when a {gtsummary} object is printed: gtsummary.as_gt.addl_cmds

  • Added include = and exclude = arguments to tbl_uvregression() (#240)

  • Added standard evaluation variants, tbl_summary_() and add_p_() (#223)

  • Added as_tibble() function that converts any {gtsummary} table to a tibble (#245)

  • New show_single_row argument in tbl_regression() and tbl_uvregression() allows any binary variable to be printed on a single row. Previous argument show_yesno is now deprecated. (#220)

Documentation

  • Added a gallery of tables possible by merging, stacking, and modifying {gtsummary} arguments (#258)

  • Added a vignette documenting each global option that can be set in {gtsummary} (#289)

  • Added {lifecycle} badges to mark deprecated and experimental functions (#225)

Other Updates

  • The by = column in tbl_summary() now has missing variables dropped rather than halting with error (#279)

  • Bug fix in vars() selection where only first variable listed was being selected (#259)

  • Bug fix where logical variable labels printed as NA in tbl_regression() (#248)

  • tbl_merge() now interprets tab_spanner = text with gt::md() (#253)

  • No longer checking outcome variable name for consistency in tbl_regression()—only checking independent variable names (#287)

  • Improved error messaging for add_global_p() (#243)

  • Removed gt::cols_merge() function ahead of the {gt} package PR 355 that changes the cols_merge() API (#222)

  • Updated API for using custom functions to calculate p-values in add_p(). User now may reference a custom function by its name. (#226)

  • Removed legacy support for tidyr version less than 1.0.0 (#235)

gtsummary 1.2.1 2019-08-20

  • Vignettes no longer install the {gt} package (required for CRAN check) (#217)

  • Added ability to name custom add_p() tests (#213)

gtsummary 1.2.0 2019-08-19

  • Users can pass variable names in backticks (#212)

  • The group = argument in tbl_summary() has been moved to add_p() (#208)

  • Users can now write custom functions to calculate p-values in add_p() (#194)

  • In tbl_summary() the by = argument accepts a bare variable name instead of the variable name passed as a string (#193)

  • Added support for column, row, and cell percentages in tbl_summary() (#181)

  • Users can now set default p-value formatting functions, regression coefficient formatting functions, default level for confidence intervals, and formatting functions in tbl_survival() (#120)

  • The {gt} package is no longer a required dependency. If {gt} is not installed, tables will be printed with knitr::kable(). The as_kable() function was added to the package as well. (#180)

  • The function as_gt() now has include = and exclude = arguments

  • Updated some function names to be the same as they were in the first version

  • Passing named lists in tbl_summary() is now defunct.

  • tbl_stack() fix for tbl_uvregression objects (#175)

  • Option to exclude some variables from testing when using add_p() (#164)

  • Updates after {gt} package renamed cells_style() to cell_text() (#78)

gtsummary 1.1.1 Unreleased

gtsummary 1.1.0 Unreleased

gtsummary 1.0.0 Unreleased

First release since major re-factoring. The {gt} package is now used as the print engine to create all tables. Some function names have been modified to be more in line with other {gt} function calls, and additional functions have been added. The API for some functions has also been updated. Review documentation and vignettes for details.

Updated Function Names

    tbl_summary()       <-  fmt_table1()
    tbl_regression()    <-  fmt_regression()
    tbl_uvregression()  <-  fmt_uni_regression()
    style_pvalue()      <-  fmt_pvalue()
    style_percent       <-  fmt_percent()
    style_ratio         <-  fmt_beta()

New Functions

    tbl_survival()          as_gt()  
    tbl_merge()             style_sigfig()  
    add_nevent()            gtsummary_logo()

gtsummary 0.1.0 2019-05-10

First version of package available here.