Skip to contents

Format a class specification as a string

Source: R/class-spec.R
S7_class_desc.Rd

S7_class_desc() turns any class specification into a short, human-readable, string, suitable for use in user-facing messages.

Usage

S7_class_desc(class)

Arguments

class

A class specification.

Value

A string.

Examples

S7_class_desc(class_integer)
#> [1] "<integer>"
S7_class_desc(new_S3_class("data.frame"))
#> [1] "S3<data.frame>"
S7_class_desc(class_integer | class_double)
#> [1] "<integer> or <double>"
S7_class_desc(NULL)
#> [1] "<NULL>"