examples/stackoverflow/57663257_reprex.md

In dewittpe/qwraps2: Quick Wraps 2

The object generated by qwraps2::summary_table is a character matrix with the class attribute qwraps2_summary_table. The qwraps2:::print.qwraps2_summary_table and qwraps2:::print.qable methods are responsible for the way the table is presented in the output. Chunk options will be responsible for how the table is rendered in the output document.

Update: as of qwraps2 version 0.5.0 the use of the .data is no longer needed or recommended.

options(qwraps2_markup = "markdown")
library(qwraps2)

eg_data <- data.frame(Age = rnorm(1000, mean = 54, sd = 10))

age_summary <- list("Age" =
                    list(
                         "Min" = ~ min(Age),
                         "Max" = ~ max(Age),
                         "Mean" = ~ mean_sd(Age)
                        )
                   )

age_table <- summary_table(eg_data, age_summary)

Take a look at the structure of age_table

str(age_table)
#>  'qwraps2_summary_table' chr [1:3, 1] "25.1137149669314" "83.5664804448924" ...
#>  - attr(*, "dimnames")=List of 2
#>   ..$ : chr [1:3] "Min" "Max" "Mean"
#>   ..$ : chr "eg_data (N = 1,000)"
#>  - attr(*, "rgroups")= Named int 3
#>   ..- attr(*, "names")= chr "Age"
#>  - attr(*, "n")= int 1000

As noted above, the object is a 3 x 1 character matrix of class qwraps2_summary_table. To see the return in the R console:

print.default(age_table)
#>      eg_data (N = 1,000)  
#> Min  "25.1137149669314"   
#> Max  "83.5664804448924"   
#> Mean "53.75 ± 9.94"
#> attr(,"rgroups")
#> Age 
#>   3 
#> attr(,"n")
#> [1] 1000
#> attr(,"class")
#> [1] "qwraps2_summary_table" "matrix"                "array"

Since the options(qwraps2_markup = "markdown") as been set, the printing method will return a markdown table

age_table
#> 
#> 
#> |                  |eg_data (N = 1,000) |
#> |:-----------------|:-------------------|
#> |**Age**           |          |
#> |   Min  |25.1137149669314    |
#> |   Max  |83.5664804448924    |
#> |   Mean |53.75 ± 9.94 |

Make sure you have the results = "asis" chunk option set in your .Rmd file so that the table will render correctly in your output document. Created on 2020-09-14 by the reprex package (v0.3.0)

devtools::session_info()
#> ─ Session info ───────────────────────────────────────────────────────────────
#>  setting  value                       
#>  version  R version 4.0.2 (2020-06-22)
#>  os       macOS Catalina 10.15.6      
#>  system   x86_64, darwin17.0          
#>  ui       X11                         
#>  language (EN)                        
#>  collate  en_US.UTF-8                 
#>  ctype    en_US.UTF-8                 
#>  tz       America/Denver              
#>  date     2020-09-14                  
#> 
#> ─ Packages ───────────────────────────────────────────────────────────────────
#>  package     * version date       lib source        
#>  assertthat    0.2.1   2019-03-21 [1] CRAN (R 4.0.0)
#>  backports     1.1.9   2020-08-24 [1] CRAN (R 4.0.2)
#>  callr         3.4.4   2020-09-07 [1] CRAN (R 4.0.2)
#>  cli           2.0.2   2020-02-28 [1] CRAN (R 4.0.0)
#>  crayon        1.3.4   2017-09-16 [1] CRAN (R 4.0.0)
#>  desc          1.2.0   2018-05-01 [1] CRAN (R 4.0.0)
#>  devtools      2.3.1   2020-07-21 [1] CRAN (R 4.0.2)
#>  digest        0.6.25  2020-02-23 [1] CRAN (R 4.0.0)
#>  ellipsis      0.3.1   2020-05-15 [1] CRAN (R 4.0.0)
#>  evaluate      0.14    2019-05-28 [1] CRAN (R 4.0.0)
#>  fansi         0.4.1   2020-01-08 [1] CRAN (R 4.0.0)
#>  fs            1.5.0   2020-07-31 [1] CRAN (R 4.0.2)
#>  glue          1.4.2   2020-08-27 [1] CRAN (R 4.0.2)
#>  highr         0.8     2019-03-20 [1] CRAN (R 4.0.0)
#>  htmltools     0.5.0   2020-06-16 [1] CRAN (R 4.0.0)
#>  knitr         1.29    2020-06-23 [1] CRAN (R 4.0.0)
#>  magrittr      1.5     2014-11-22 [1] CRAN (R 4.0.0)
#>  memoise       1.1.0   2017-04-21 [1] CRAN (R 4.0.0)
#>  pkgbuild      1.1.0   2020-07-13 [1] CRAN (R 4.0.2)
#>  pkgload       1.1.0   2020-05-29 [1] CRAN (R 4.0.0)
#>  prettyunits   1.1.1   2020-01-24 [1] CRAN (R 4.0.0)
#>  processx      3.4.4   2020-09-03 [1] CRAN (R 4.0.2)
#>  ps            1.3.4   2020-08-11 [1] CRAN (R 4.0.2)
#>  qwraps2     * 0.5.0   2020-09-14 [1] local         
#>  R6            2.4.1   2019-11-12 [1] CRAN (R 4.0.0)
#>  Rcpp          1.0.5   2020-07-06 [1] CRAN (R 4.0.0)
#>  remotes       2.2.0   2020-07-21 [1] CRAN (R 4.0.2)
#>  rlang         0.4.7   2020-07-09 [1] CRAN (R 4.0.2)
#>  rmarkdown     2.3     2020-06-18 [1] CRAN (R 4.0.0)
#>  rprojroot     1.3-2   2018-01-03 [1] CRAN (R 4.0.0)
#>  sessioninfo   1.1.1   2018-11-05 [1] CRAN (R 4.0.0)
#>  stringi       1.5.3   2020-09-09 [1] CRAN (R 4.0.2)
#>  stringr       1.4.0   2019-02-10 [1] CRAN (R 4.0.0)
#>  testthat      2.3.2   2020-03-02 [1] CRAN (R 4.0.0)
#>  usethis       1.6.1   2020-04-29 [1] CRAN (R 4.0.0)
#>  withr         2.2.0   2020-04-20 [1] CRAN (R 4.0.0)
#>  xfun          0.17    2020-09-09 [1] CRAN (R 4.0.2)
#>  yaml          2.2.1   2020-02-01 [1] CRAN (R 4.0.0)
#> 
#> [1] /Library/Frameworks/R.framework/Versions/4.0/Resources/library

dewittpe/qwraps2 documentation built on Jan. 4, 2024, 1:59 p.m.