set_types {businessPlanR}R Documentation

Define valid types of revenues and expenses

Description

These functions change the globally available options of the running R session. Its values define types of transactions you want to be able to use in your business plan.

Usage

set_types(types, class = c("revenue", "expense"), name = "default")

get_types(
  name = "default",
  class = c("revenue", "expense"),
  names_only = FALSE
)

get_model()

Arguments

types

Named list, one entry for each type. Values define the color to use in plots.

class

One of "revenue" or "expense".

name

Character string, giving the set of types a name. You can use this to have multiple sets of types simultaneously in the same session.

names_only

Logical, whether the full list or only the names of defined types should be returned.

Details

The getter functions return a list of default types if none have been defined so far.

Value

set_types is a wrapper for options and adds/replaces a list called name to the businessPlanR option of the running session. get_types returns the list from the businessPlanR option. get_model just returns the internal definition of default operations model as a list.


[Package businessPlanR version 0.1-0 Index]