Inspect cost model structure

ledgr_cost_steps() returns deterministic step descriptors for a cost model. ledgr_cost_describe() returns a compact human-readable summary.

Usage

ledgr_cost_steps(cost_model)

ledgr_cost_describe(cost_model)

Arguments

cost_model

A ledgr_cost_model object.

Value

ledgr_cost_steps() returns a list; ledgr_cost_describe() returns a character scalar.

Examples

cost <- ledgr_cost_chain(
  ledgr_cost_spread_bps(5),
  ledgr_cost_fixed_fee(1),
  ledgr_cost_notional_bps_fee(2)
)
ledgr_cost_steps(cost)
#> [[1]]
#> [[1]]$position
#> [1] 1
#> 
#> [[1]]$type_id
#> [1] "spread_bps"
#> 
#> [[1]]$version
#> [1] 1
#> 
#> [[1]]$stage
#> [1] "price_transform"
#> 
#> [[1]]$args
#> [[1]]$args$bps
#> [1] 5
#> 
#> 
#> 
#> [[2]]
#> [[2]]$position
#> [1] 2
#> 
#> [[2]]$type_id
#> [1] "fixed_fee"
#> 
#> [[2]]$version
#> [1] 1
#> 
#> [[2]]$stage
#> [1] "fee_adder"
#> 
#> [[2]]$args
#> [[2]]$args$amount
#> [1] 1
#> 
#> 
#> 
#> [[3]]
#> [[3]]$position
#> [1] 3
#> 
#> [[3]]$type_id
#> [1] "notional_bps_fee"
#> 
#> [[3]]$version
#> [1] 1
#> 
#> [[3]]$stage
#> [1] "fee_adder"
#> 
#> [[3]]$args
#> [[3]]$args$bps
#> [1] 2
#> 
#> 
#> 
ledgr_cost_describe(cost)
#> [1] "ledgr cost model: 3 step(s), hash 29bb4f09f21c\n1. spread_bps [price_transform] bps=5\n2. fixed_fee [fee_adder] amount=1\n3. notional_bps_fee [fee_adder] bps=2"