deprecated: Set, Retrieve and Skip Deprecated Variables.

In kamapu/dfplus: Data Frames with Metadata

Set, Retrieve and Skip Deprecated Variables.

Description

The variable class "deprecated" is implemented in the package dfplus as an alternative to avoid deletion of columns in the input files.

Usage

## S4 method for signature 'dfplus'
deprecated(x, ...)
## S4 method for signature 'dfplus'
skip_deprecated(x, ...)

deprecated(x) <- value

Arguments

x	An object of class dfplus.
value	A character vector with the names of variables to be set as deprecated.
...	Further arguments passed to or from other methods.

Details

The variable class "deprecated" is useful to indicate variables in input spreadsheets that may be irrelevant or redundant. In such cases the application of deprecated is less risky than deleting such columns from the table.

The first method in Usage retrieves a logical vector indicating which variables are deprecated, while the last one is used to set variables as deprecated.

The function skip_deprecated will delete deprecated variables from the dfplus object.

Value

A logical vector or an object of class dfplus.

Author(s)

Miguel Alvarez ([e-mail]).

Examples

## Add example for this function

kamapu/dfplus documentation built on March 27, 2022, 4:10 a.m.