getProxyFunction: Function to compute the proxy variable of a segment

In mbask/RBSperformance: An R package to aid in RBS estimations

Description

The proxy variable, in the RBS framework, is a linearly well-correlated variable to the target variable and is used to estimate the target variable estimator

Usage

  getProxyFunction(proxyVar = "kExpDiameter",
    scalingFactor = 2.5)

Arguments

proxyVar	a string defining the formula for the computation of the proxy variable. One of "kExpDiameter" (default) or "cylinder" values.
scalingFactor	k value, used when 'proxyVar' is "kExpDiameter" (default 2.5)

Value

a function to be used to compute the proxy variable at segment level

Note

This is a container function for a closure, whose parameters vary according to the proxy variable chosen. For "kExpDiameter" the function requires 'd', the diameter of the segment, and 'l' a variable defaulting to 'NULL' (only provided to be compatible with the "cylinder" function); for "cylinder" the function requires 'd' and 'l', the length of the segment.

Examples

getDProxy <- getProxyFunction()
getDProxy(d = 10)
getDHProxy <- getProxyFunction(proxyVar = "cylinder")
getDHProxy(d = 10, l = 7)

mbask/RBSperformance documentation built on May 21, 2019, 2:25 p.m.