opts_ordered {constructive} | R Documentation |
Constructive options for class 'ordered'
Description
These options will be used on objects of class 'ordered'.
Usage
opts_ordered(
constructor = c("ordered", "factor", "new_ordered", "next", "integer"),
...
)
Arguments
constructor |
String. Name of the function used to construct the object, see Details section. |
... |
Additional options used by user defined constructors through the |
Details
Depending on constructor
, we construct the object as follows:
-
"ordered"
(default): Build the object usingordered()
, levels won't be defined explicitly if they are in alphabetical order (locale dependent!) -
"factor"
: Same as above but build the object usingfactor()
andordered = TRUE
. -
"new_ordered"
: Build the object usingvctrs::new_ordered()
. Levels are always defined explicitly. -
"next"
: Use the constructor for the next supported class. Call.class2()
on the object to see in which order the methods will be tried. -
"integer"
: We define as an integer vector and repair attributes
Value
An object of class <constructive_options/constructive_options_ordered>