units (version 0.8-5)

drop_units: Drop Units

Description

Drop units attribute and class.

Usage

drop_units(x)
# S3 method for units
drop_units(x)
# S3 method for data.frame
drop_units(x)
# S3 method for mixed_units
drop_units(x)

Value

the numeric without any units attributes, while preserving other attributes like dimensions or other classes.

Arguments

x

an object with units metadata.

Details

Equivalent to units(x) <- NULL, or the pipe-friendly version set_units(x, NULL), but drop_units will fail if the object has no units metadata. Use the alternatives if you want this operation to succeed regardless of the object type.

A data.frame method is also provided, which checks every column and drops units if any.

Examples

x <- 1
y <- set_units(x, m/s)

# this succeeds
drop_units(y)
set_units(y, NULL)
set_units(x, NULL)

if (FALSE) {
# this fails
drop_units(x)
}

df <- data.frame(x=x, y=y)
df
drop_units(df)