Package 'crosstabser'

Description

This function first calls datadaptor::create_mapping_workbook(). Additionally to the sheets "Variables", "Label", "Verbatims" & "Free", it will insert 2 more sheets "Macro" & "Questions". The Excel workbook is then written to the file mapping_file. Please refer to vignette("crosstabser") & vignette("questions-parameters") for details how to use the mapping.

Usage

create_tabula(df_raw, mapping_file, mapping_type = "excel")

Arguments

Examples

spss_file <- system.file(
  "extdata",
  "fruit_survey.sav",
  package = "datadaptor"
)
df <- haven::read_sav(spss_file)
# The next command creates an empty mapping file `mapping.xlsx`:
## Not run: 
create_tabula(df, "mapping.xlsx")

## End(Not run)

Description

This helper function generates a json string containing the data produced by Tabula$get_crosstabs_data(), and which then can be put as the "data" attribute of the ⁠<table-charter>⁠ app. It is also used by Tabula$save_html_app()

Usage

gen_data_json(l)

Arguments

Value

A character string

Examples

df <- tibble::tibble(
  q1 = c(1, 2, 1) |> haven::labelled(c(Yes = 1, No = 2), label = "Super important question"),
  age = c(2, 1, 1) |> haven::labelled(c("18-39" = 1, "40+" = 2), label = "age")
)
mapping_file = list(
  Questions = data.frame(
    Type  = "cat",
    RowVar = "q1",
    Title = "The crosstab's title"
  ),
  Macro = list(ColVar = "age")
)
m <- Tabula$new(df, mapping_file)
m$get_crosstabs_data() |> gen_data_json()

Description

Generate list of options for a Tabula object

Usage

get_tabula_options(tabula, book_no = NULL, ...)

Arguments

Examples

## Not run: 
# TODO: document!
- for this we should add an example excel mapping file to the crosstabser package
- and then add a docs example, something like this:
# Only for documentation purposes:
# (`get_mapping_options()` isn't supposed to be be called directly).
mapping_file <- system.file(
  "extdata",
  "<file-to-be-created-mapping.xlsx>",
  package = "crosstabser"
)
m <- Tabula$new(mapping_file = mapping_file)
# Result of datadaptor::get_mapping_options() in `da` field:
m$opts$da
# Result of get_tabula_options() in `da` field:
m$opts$ct

## End(Not run)

Description

Print object of class "Qtab"

Usage

## S3 method for class 'Qtab'
print(x, ...)

Arguments

Examples

# see `?Tabula`

Description

This is not supposed to be used directly. When creating a "Tabula" object, this will generate a list of Qrow objects in its ⁠$qrows⁠ field.

Public fields

Methods

Public methods

• Qrow$new()

• Qrow$clone()

Method new()

Usage

Qrow$new(df_qrow, mapping, ...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Qrow$clone(deep = FALSE)

Arguments

Examples

# see `?Tabula`

Description

This is not supposed to be used directly. When creating a "Tabula" object, this will generate a list of Qrow objects in its ⁠$qrows⁠ field, themselves each containing a list of Qtab objects in their ⁠$qtabs⁠ fields.

Details

Qtab objects have a custom print method print.Qtab (see examples in ?Tabula).

Public fields

Methods

Public methods

• Qtab$new()

• Qtab$clone()

Method new()

Usage

Qtab$new(params, mapping, ...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Qtab$clone(deep = FALSE)

Arguments

Examples

# see `?Tabula`

Description

The class Tabula can be used to calculate the crosstabs specified on the Questions sheet of the Excel mapping file.

Super class

datadaptor::Mapping -> Tabula

Public fields

Methods

Public methods

• Tabula$new()

• Tabula$set_options()

• Tabula$calc_crosstabs()

• Tabula$save_html_app()

• Tabula$get_crosstabs_data()

• Tabula$print()

• Tabula$clone()

Method new()

Initialize a Tabula object

Usage

Tabula$new(
  dat_mod = NULL,
  mapping_file = NULL,
  row = NULL,
  dat = NULL,
  tabulate = TRUE,
  ...
)

Arguments

Method set_options()

Set Tabula options. This overwrites datadaptor::Mapping$set_options()

Usage

Tabula$set_options(...)

Arguments

Method calc_crosstabs()

Calculate the crosstabs

Usage

Tabula$calc_crosstabs(row = NULL)

Arguments

Method save_html_app()

Write a table_charter app html file of the crosstab data

Usage

Tabula$save_html_app(
  template_file =
    "https://gitlab.com/urswilke/table_charter/-/raw/main/example_dashboard.html",
  output_file = "dashboard.html",
  project_data = NULL
)

Arguments

Details

This needs a valid html template_file, i.e. one of:

• The file example_dashboard.html which is directly scraped from the table_charter repo by default (no installation of table_charter needed).

• For deploying it in the web or running it on a dev server, you need to install table_charter first, and then use the file index.html on your machine.

• After installing, you can also generate a standalone html file (without the need to download javascript libraries) by running:

    npm run standalone-build
  

  and then using the template file created in the ⁠dist/⁠ sub-directory.

Method get_crosstabs_data()

Return the crosstabs data of the Tabula object

This method returns a list of dataframes containing all the crosstabs information. Thus it's not chainable.

Usage

Tabula$get_crosstabs_data()

Returns

A list of dataframes with the data of the crosstabs; see vignette("data-format").

Method print()

Print the crosstabs of the Tabula object

This method is called under the hood, if you print() a Tabula object. This will call the print method of all Qrow elements in the Tabula$qrows field.

Usage

Tabula$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Tabula$clone(deep = FALSE)

Arguments

Examples

df <- tibble::tibble(
  q1 = c(1, 2, 1) |> haven::labelled(c(Yes = 1, No = 2), label = "Super important question"),
  age = c(2, 1, 1) |> haven::labelled(c("18-39" = 1, "40+" = 2), label = "age")
)
mapping_file = list(
  Questions = data.frame(
    Type  = "cat",
    RowVar = "q1",
    Title = "The crosstab's title"
  ),
  Macro = list(ColVar = "age")
)
m <- Tabula$new(df, mapping_file)
m
# The previous line prints the "Tabula" object.
# Under the hood, a list of `Qrow` objects were generated.
# Printing `m` prints the list of `Qtab` elements of each `Qrow`:
m$qrows
# For instance, this prints the list of `Qtab` elements
# of the first `Qrow` element:
m$qrows[[1]]$qtabs |> print()

Description

This helper function is used by Tabula$save_html_app() to write a table_charter app html file of crosstab data.

Usage

write_html_app(
  data_string,
  template_file =
    "https://gitlab.com/urswilke/table_charter/-/raw/main/example_dashboard.html",
  output_file = "dashboard.html",
  project_data = NULL
)

Arguments

Value

No value's returned. This function writes a file.

Examples

# See documentation of `Tabula$save_html_app()`