| Title: | Factors with Levels |
|---|---|
| Description: | Provides an extension to factors called 'lfactor' that are similar to factors but allows users to refer to 'lfactor' levels by either the level or the label. |
| Authors: | Paul Bailey [aut, cre] |
| Maintainer: | Paul Bailey <[email protected]> |
| License: | GPL-2 |
| Version: | 1.0.4 |
| Built: | 2024-11-03 05:36:04 UTC |
| Source: | https://github.com/pdbailey0/lfactors |
Similar to a factor, the user defines levels and labels when
creating an lfactor. This is especially useful when
labels are long, and users know the levels well.
See lfactor for examples.
Returns a factor from an lfactor.
## S3 method for class 'lfactor' as.factor(x)## S3 method for class 'lfactor' as.factor(x)
x |
the lfactor to be coerced to a factor |
Simply drops the numeric levels from the lfactor and returns a normal factor.
Returns integer representation of an lfactor that ignores the values used in
the levels argument when the lfactor was created and instead returns
an integer representation starting with 1.
## S3 method for class 'lfactor' as.integer(x, ...)## S3 method for class 'lfactor' as.integer(x, ...)
x |
same as |
... |
not used |
This method does not return integer results that are otherwise equal to the
results from as.numeric for compatibility with
sparse.model.matrix.
as.integer, as.numeric.lfactor
require(lfactors) # create an example let <- lfactor(4:12, levels=4:12, labels=letters[4:12]) as.numeric(let) #same as as.numeric(4:12) as.integer(let) #same as 1:9require(lfactors) # create an example let <- lfactor(4:12, levels=4:12, labels=letters[4:12]) as.numeric(let) #same as as.numeric(4:12) as.integer(let) #same as 1:9
Returns numeric representation of an lfactor equal to the levels
argument for each value. This is different from the behavior of factor which
would ignore the values of level.
## S3 method for class 'lfactor' as.numeric(x, ...)## S3 method for class 'lfactor' as.numeric(x, ...)
x |
same as |
... |
not used |
This method does not return floating point (numeric) results that are otherwise equal to the results from as.integer.lfactor.
Instead it returns the value of the level that was input when the lfactor was created.
as.numeric,
as.integer.lfactor
require(lfactors) # create an example let <- lfactor(4:12, levels=4:12, labels=letters[4:12]) as.numeric(let) #same as as.numeric(4:12) as.integer(let) #same as 1:9require(lfactors) # create an example let <- lfactor(4:12, levels=4:12, labels=letters[4:12]) as.numeric(let) #same as as.numeric(4:12) as.integer(let) #same as 1:9
Implements %in% for lfactors.
inlf(x, table)inlf(x, table)
x |
same as |
table |
same as |
lfactor creates a factor that can be compared to its levels or labels.
lfactor(x, levels, labels = levels, ...)lfactor(x, levels, labels = levels, ...)
x |
a numeric or character vector of data. Levels of x can be taken either from levels or labels. |
levels |
a numeric vector of levels in x. Note that, unlike
|
labels |
a vector of labels for the levels. This vector must be either characters that cannot be cast as numeric or characters that are equal to the level, of the same index, when cast as numeric. |
... |
arguments passed to |
An lfactor can be compared to the levels or the labels (see the Examples). Because of that, the levels must be numeric, and the labels must be either not castable as numeric or equal to the levels of the same index when cast as numeric.
An lfactor is, essentially, a factor that remembers the levels
as well as the labels argument.
Note that all of the arguments are passed to
factor. Because lfactor imposes
some additional constraints on the types of levels and labels
and stores additional information,
an lfactor uses more memory than a factor—because it stores both
labels and levels—and is,
in some ways, more limited than a factor.
An object of class lfactor that also implements factor
require(lfactors) # make an example lfactor object mon <- lfactor(1:12, levels=1:12, labels=c("Jan", "Feb", "Mar", "Apr", "May","Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec")) # print out the lfactor mon # compare to label mon == "Feb" # Compare to level mon == 2 # Show that the == works correctly all.equal(mon == "Feb", mon == 2) # Show that the != works correctly all.equal(mon != "Feb", mon != 2) # also works when the vector is not the lfactor all.equal(mon[3] == c("Jan", "Feb", "Mar"), mon[3] == 1:3) # or when both the lfactor and the object being compare to are vectors all.equal(mon[1:2] == c("Feb", "Tuesday"), mon[1:2] == c(2,-4) ) # similar to Ops.factor, this gives a helpful warning and NA results mon >= "Jan" # %in% works correctly all.equal(mon %in% c(2, 3), mon %in% c("Feb", "Mar")) # and when the lfactor is on the right all.equal(c(-4, 14,3,10) %in% mon, c("not a month", "Third December","Mar","Oct") %in% mon) # and when both left and right are lfactors all.equal(mon %in% mon, rep(TRUE,12))require(lfactors) # make an example lfactor object mon <- lfactor(1:12, levels=1:12, labels=c("Jan", "Feb", "Mar", "Apr", "May","Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec")) # print out the lfactor mon # compare to label mon == "Feb" # Compare to level mon == 2 # Show that the == works correctly all.equal(mon == "Feb", mon == 2) # Show that the != works correctly all.equal(mon != "Feb", mon != 2) # also works when the vector is not the lfactor all.equal(mon[3] == c("Jan", "Feb", "Mar"), mon[3] == 1:3) # or when both the lfactor and the object being compare to are vectors all.equal(mon[1:2] == c("Feb", "Tuesday"), mon[1:2] == c(2,-4) ) # similar to Ops.factor, this gives a helpful warning and NA results mon >= "Jan" # %in% works correctly all.equal(mon %in% c(2, 3), mon %in% c("Feb", "Mar")) # and when the lfactor is on the right all.equal(c(-4, 14,3,10) %in% mon, c("not a month", "Third December","Mar","Oct") %in% mon) # and when both left and right are lfactors all.equal(mon %in% mon, rep(TRUE,12))
llevels gives the numeric levels of an lfactor.
llevels(x)llevels(x)
x |
object of class lfactor |
A vector of levels
match Function for lfactorsmatch function for lfactors.
mlfactor(x, table, nomatch = NA_integer_, incomparables = NULL)mlfactor(x, table, nomatch = NA_integer_, incomparables = NULL)
x |
same as |
table |
same as |
nomatch |
same as |
incomparables |
same as |
Allows match to work when the x or table arguments in a call to match are lfactors.