Skip to contents

These options will be used on objects of class 'ordered'.

Usage

opts_ordered(
  constructor = c("ordered", "factor", "new_ordered", "next", "atomic"),
  ...
)

Arguments

constructor

String. Name of the function used to construct the object, see Details section.

...

Should not be used. Forces passing arguments by name.

Value

An object of class <constructive_options/constructive_options_ordered>

Details

Depending on constructor, we construct the object as follows:

  • "ordered" (default): Build the object using ordered(), levels won't be defined explicitly if they are in alphabetical order (locale dependent!)

  • "factor" : Same as above but build the object using factor() and ordered = TRUE.

  • "new_ordered" : Build the object using vctrs::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.

  • "atomic" : We define as an atomic vector and repair attributes