View and modify dataset-level settings

Source: R/dataset.R

These methods allow access and control over dataset settings. Currently supported settings include:

  • User Authorizations for view-only users ('viewers_can_export', 'viewers_can_share', and 'viewers_can_change_weight'); and

  • 'weight', which determines the default weighting variable for the dataset Additional settings will be added in the future. See https://crunch.io/api/reference/#post-/datasets/ -> request body model -> settings key, for an up-to-date list of settings supported throughout the Crunch system. Clients may also provide and use custom settings if they choose.

settings(x)

settings(x) <- value

Arguments

x

CrunchDataset

value

A settings object (ShojiEntity), for the setter

Value

The getter returns a settings object (ShojiEntity). The setter returns the dataset (x), duly modified.

Examples

if (FALSE) {
settings(ds)
settings(ds)$viewers_can_export <- TRUE
settings(ds)$weight <- ds$myWeightVariable
}