r2spss (version 0.3.2)

r2spss_options: Options for package r2spss

Description

Retrieve or set global options for package r2spss (within the current R session) via accessor functions.

Usage

r2spss_options

Format

A list with the following two components:

get(which, drop = TRUE)

an accessor function to retrieve current options, which are usually returned as a named list. Argument which allows to select which options to retrieve. If a single option is selected, argument drop indicates whether only its value should be returned (TRUE) or a list of length one (FALSE).

set(...)

an accessor function to set certain options using name = value pairs.

Details

The following options are available:

version

a character string that controls the default for whether tables and plots should mimic the content and look of recent SPSS versions ("modern") or older versions (<24; "legacy").

minor

a logical that overrides whether function to_latex should include any supplied minor grid lines in SPSS tables. In particular for tables that mimic older SPSS versions, minor grid lines can be somewhat distracting from the content, so setting this option to FALSE provides a quick way to suppress them. The look of the resulting tables still closely mimics SPSS while being somewhat cleaner.

Examples

# NOT RUN {
# retrieve the list of options
r2spss_options$get()

# retrieve a single option
r2spss_options$get("version")

# }
# NOT RUN {
# set options
r2spss_options$set(version = "legacy", minor = FALSE)
# }
# NOT RUN {
# }