Skip to contents

Inspect or change COPYRIGHT.

Usage

px_copyright(x, value, validate)

# S3 method for class 'px'
px_copyright(x, value, validate = TRUE)

Arguments

x

A px object

value

Optional. A character string. If missing, the current COPYRIGHT is returned. If NULL, COPYRIGHT is removed.

validate

Optional. If TRUE a number of validation checks are performed on the px object, and an error is thrown if the object is not valid. If FALSE, the checks are skipped, which can be usefull for large px objects where the check can be time consuming. Use px_validate() to manually preform the check.

Value

A px object or a character string.

Examples

# Set COPYRIGHT
x1 <-
   px(population_gl) |>
   px_copyright('YES')

# Print COPYRIGHT
px_copyright(x1)
#> [1] "YES"

# Remove COPYRIGHT
x2 <- px_copyright(x1, NULL)
px_copyright(x2)
#> NULL