set_gold_classes: Set gold classes

In CorradoLanera/goldrake: Gold-standard hero

Description

Set gold classes

Usage

set_gold_classes(x, classes, ...)

## Default S3 method:
set_gold_classes(x, classes, ...)

## S3 method for class 'goldrake'
set_gold_classes(x, classes = c("0", "1"), ...,
  force = FALSE)

Arguments

x	a goldrake object
classes	(chr, default c("0", "1")) Classes admitted for the classification.
...	further arguments passed to the methods
force	(lgl, default = TRUE) if TRUE, overwrite possible classes already set.

Value

invisibly, a goldrake object with updated classes

Examples

goldrake(mtcars) %>%
    set_gold_classes()

goldrake(mtcars) %>%
    set_gold_classes(c("good", "bad", "so and so"))

goldrake(mtcars) %>%
    set_gold_classes(c("good", "bad", "so and so")) %>%
    set_gold_classes(c("0", "1"))

goldrake(mtcars) %>%
    set_gold_classes(c("good", "bad", "so and so")) %>%
    set_gold_classes(c("0", "1"), force = TRUE)

## Not run: 
    # an error
    set_gold_classes(1)

    # another error
    goldrake(mtcars) %>%
        set_gold_classes(1)

## End(Not run)

CorradoLanera/goldrake documentation built on May 30, 2019, 3:07 a.m.