build_example_coin {COINr}

R Documentation

Build ASEM example coin

Description

Shortcut function to build the ASEM example coin, using inbuilt example data. This can be useful for testing and also for building reproducible examples. To see the underlying commands run edit(build_example_coin). See also vignette("coins").

Usage

build_example_coin(up_to = NULL, quietly = FALSE)

Arguments

up_to	The point up to which to build the index. If NULL, builds full index. Else specify a building function (as a string) - the index will be built up to and including this function. This option is mainly for helping with function examples. Example: up_to = "Normalise".
quietly	If TRUE, suppresses all messages.

Details

This function replaces the now-defunct build_ASEM() from COINr < v1.0.

Value

coin class object

Examples

# build example coin up to data treatment step
coin <- build_example_coin(up_to = "Treat")
coin

---