lab_int_to_factor {labelr}R Documentation

Convert a Value-labeled Integer Variable Column to a Factor Variable Column

Description

lab_int_to_factor converts a value-labeled integer variable to a factor, using labelr value labels as factor level labels and returning the modified data.frame.

Usage

lab_int_to_factor(data, var, ordered = FALSE)

int2f(data, var, ordered = FALSE)

Arguments

data

a data.frame object.

var

the (unquoted) name of a value-labeled integer variable found in data.

ordered

logical flag to determine if resulting factor levels should be regarded as ordered (in ascending order of the integer values of var).

Details

Note 1: int2f is a compact alias for lab_int_to_factor: they do the same thing, and the former is easier to type.

Note 2: This function can be used to produce ordered factors but will not do so by default (see argument ordered).

Note 3: This function's effects are NOT straightforwardly "undone" by factor_to_lab_int() See the latter's documentation for more information and an example demonstration.

Value

a data.frame.

Examples

class(iris[["Species"]])

iris_sp_int <- factor_to_lab_int(iris, Species)
class(iris_sp_int[["Species"]])

get_val_labs(iris_sp_int, "Species")
iris_sp_fac <- lab_int_to_factor(iris_sp_int, Species)

class(iris_sp_fac[["Species"]])

levels(iris_sp_fac[["Species"]])

# copy data.frame mtcars to mt2
mt2 <- mtcars

# add value labels to mtcars$carb and assign data.frame to object mt2
mt2 <- add_val_labs(
  data = mt2,
  vars = "carb",
  vals = c(1, 2, 3, 4, 6, 8),
  labs = c(
    "1c", "2c", # a tad silly, but these val labels will demo the principle
    "3c", "4c",
    "6c", "8c"
  )
)

# carb as labeled integer
class(mt2$carb)
levels(mt2$carb)
head(mt2$carb, 3)
lm(mpg ~ carb, data = mt2)
(adj_r2_int <- summary(lm(mpg ~ carb, data = mt2))$adj.r.squared)
AIC(lm(mpg ~ carb, data = mt2))

# carb as factor
carb_fac <- mt2 # copy mt2 to new data.frame carb_fac
carb_fac <- lab_int_to_factor(carb_fac, carb) # alias int2f() also works
class(carb_fac$carb)
levels(carb_fac$carb)
head(carb_fac$carb, 3)
lm(mpg ~ carb, data = carb_fac)
(adj_r2_fac <- summary(lm(mpg ~ carb, data = carb_fac))$adj.r.squared)
AIC(lm(mpg ~ carb, data = carb_fac))

[Package labelr version 0.1.5 Index]