Skip to contents

NOTE

Source: R/modify_note.R
px_note.px.Rd

Inspect or change NOTE.. NOTE can be set for the entire table or for a specific variable.

Usage

px_note(x, value)

# S3 method for class 'px'
px_note(x, value)

Arguments

x

A px object

value

Optional. A character string, a data frame, or a list.

  • Use character, to set NOTE for the entire table across all languages.

  • Use a data frame with columns 'language' and 'value' to set NOTE for the entire table in a specific language.

  • Use a data frame with the columns 'variable-code' and 'note', to set NOTE for a specific variable across all languages. Add the column 'language' to set NOTE for specific language.

  • Use a list of the above elements to set NOTE in muliple ways. This is the same as calling NOTE multiple times with different values.

  • If missing, the current NOTE is returned.

  • If NULL, NOTE is removed for the table and all variables.

Value

A px object, a character string, a data frame, or a list of character strings and/or data frames.