Inspect feature contracts

ledgr_feature_contracts() shows what ledgr will compute before a run. It accepts the same feature declarations used by experiments: a feature map, a named or unnamed list of indicators, or one indicator.

Usage

ledgr_feature_contracts(features)

Arguments

features

A ledgr_feature_map, a list of ledgr_indicator objects, or one ledgr_indicator.

Value

A tibble with columns alias, feature_id, source, requires_bars, and stable_after.

Articles

Indicators, feature IDs, and pulse feature views:

vignette("indicators", package = "ledgr") system.file("doc", "indicators.html", package = "ledgr")

Examples

features <- ledgr_feature_map(
  ret_5 = ledgr_ind_returns(5),
  sma_10 = ledgr_ind_sma(10)
)

ledgr_feature_contracts(features)
#> # A tibble: 2 × 5
#>   alias  feature_id source requires_bars stable_after
#>   <chr>  <chr>      <chr>          <int>        <int>
#> 1 ret_5  return_5   ledgr              6            6
#> 2 sma_10 sma_10     ledgr             10           10