build_example_purse {COINr}

Build example purse

Description

Shortcut function to build an example purse. This is currently an "artificial" example, in that it takes the ASEM data set used in build_example_coin() and replicates it for five years, adding artificial noise to simulate year-on-year variation. This was done simply to demonstrate the functionality of purses, and will at some point be replaced with a real example. See also vignette("coins").

Usage

build_example_purse(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 ⁠build_*⁠ 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 = "build_normalise".

quietly

If TRUE, suppresses all messages.

Value

purse class object

Examples

# build example purse up to unit screening step
purse <- build_example_purse(up_to = "Screen")
purse