Basic printing

If a tabulation function is called from the top level, it should print out its table(s) on its own.

As usual, first, let’s start up the package and pick a survey to analyze:

library(surveytable)
set_survey(namcs2019sv)

Now, when a tabulation function is called from the top level, it prints. You don’t need to do anything extra.

tab("AGER")

If a tabulation function is called not from the top level, such as from within a loop or another function, you do need to call print() explicitly for it to print. For example:

for (vr in c("AGER", "SEX")) {
  print( tab_subset(vr, "MAJOR", "Preventive care") )
}

Create HTML or PDF tables

Using a Quarto document, you can create tables in many different formats, such as HTML or PDF. Here is a straightforward example of what a Quarto document might look like:

---
title: "My tables"
author: "Me"
format: pdf
---

# Welcome 

As usual, first, let's start up the package and pick a survey to analyze:

```{r, results='asis'}
library(surveytable)
set_survey(namcs2019sv, output = 'auto')
```

# Tables

Take a look at this table:

```{r, results='asis'}
tab("AGER")
```

Note the format setting, which specifies that this document will create PDF tables. Also note that you do have to add the results='asis' argument to the code chunks that print tables.

Print using various table-making packages

Use the output argument of set_opts() to select a table-making package. By default (output = "auto"), surveytable automatically selects a package depending on whether the output is to the screen (huxtable), HTML (gt), or PDF (kableExtra). You can also explicitly select one of these packages.

Changing the table-making package has a couple of uses:

• Use as_object() to generate an object from your favorite table-making package, customize this object, and then finally print it, so the table looks exactly the way you want it to look.
• Print to destinations other than the screen, HTML, or PDF.

set_opts(output = "kableExtra")
#> * Printing with kableextra.

```{r, results='asis'}
tab("AGER")
```

set_opts(output = "auto")
#> * Printing with huxtable for screen, gt for HTML, or kableExtra for PDF.

```{r, results='asis'}
tab("AGER")
```

Advanced printing

tab("AGER") |> as.data.frame()
#>               Level    n Number (000) SE (000) LL (000) UL (000) Percent  SE
#> 1    Under 15 years  887       117917    14097    93229   149142    11.4 1.3
#> 2       15-24 years  542        64856     7018    52387    80292     6.3 0.6
#> 3       25-44 years 1435       170271    13966   144925   200049    16.4 1.1
#> 4       45-64 years 2283       309506    23290   266994   358787    29.9 1.4
#> 5       65-74 years 1661       206866    14366   180481   237109    20.0 1.2
#> 6 75 years and over 1442       167069    15179   139746   199735    16.1 1.3
#>     LL   UL
#> 1  8.9 14.2
#> 2  5.1  7.5
#> 3 14.3 18.8
#> 4 27.2 32.6
#> 5 17.6 22.5
#> 6 13.7 18.8

set_opts(count = "1k")
#> * Rounding counts to the nearest thousand.
tab("AGER") |> gt::gt()

Save the tables

tab("AGER", csv = "myfile.csv")

tab("AGER") |> saveRDS("myfile.rds")

readRDS("myfile.rds")

Suppress printing

There are times when you might want to prevent the tabulation functions from printing tables. If you are saving the tables to a CSV file anyway, you might not need screen printing.

As mentioned above, if the tabulation functions are called from within a loop without using the print() command, they won’t print.

An easy way to suppress printing when the tabulation functions are called from the top level is to assign the output to some variable. For example, this will save the table to a CSV file, but won’t print it to the screen:

tmp = tab("AGER", csv = "myfile.csv")