dd_screen: dd_screen_options

View source: R/dd_call_screen_options.R

dd_screenR Documentation

dd_screen_options

Description

This call applies screening criteria to a data dataset. Specifically, it can be used to apply criteria (no filtering) or apply criteria and filter based on one or more criteria (e.g., JB1, JB2)

Usage

dd_screen(
  fittingObject,
  screen = TRUE,
  JB1Flag = 0.2,
  JB2Flag = 0.1,
  filterPassing = NULL
)

Arguments

fittingObject

core fitting object

screen

(bool) set screen TRUE or FALSE (i.e. NULL)

JB1Flag

(num) bounce constant per authors (set at initial defaults)

JB2Flag

(num) extremity change constant per authors (set at initial defaults)

filterPassing

(char vector) which JB criteria to retain in dataset, e.g. c("JB1", "JB2")


miyamot0/discountingtools documentation built on March 21, 2023, 8:59 p.m.