Sweep retention policy

ledgr_sweep_retention() creates a classed retention policy for ledgr_sweep(). Retention controls which optional sweep evidence is kept in memory or later persisted. It is not part of execution identity.

Usage

ledgr_sweep_retention(
  returns = c("none", "completed"),
  trades = c("none", "closed")
)

Arguments

returns

Character scalar. "none" keeps the current scalar-only sweep output. "completed" requests retained net equity/return series for completed candidates.

trades

Character scalar. "none" keeps no trade evidence. "closed" requests retained closed-trade evidence for completed candidates.

Value

A ledgr_sweep_retention object.

Examples

ledgr_sweep_retention()
#> $retention_schema_version
#> [1] 2
#> 
#> $returns
#> [1] "none"
#> 
#> $trades
#> [1] "none"
#> 
#> attr(,"class")
#> [1] "ledgr_sweep_retention" "list"                 
ledgr_sweep_retention("completed")
#> $retention_schema_version
#> [1] 2
#> 
#> $returns
#> [1] "completed"
#> 
#> $trades
#> [1] "none"
#> 
#> attr(,"class")
#> [1] "ledgr_sweep_retention" "list"                 
ledgr_sweep_retention(returns = "completed", trades = "closed")
#> $retention_schema_version
#> [1] 2
#> 
#> $returns
#> [1] "completed"
#> 
#> $trades
#> [1] "closed"
#> 
#> attr(,"class")
#> [1] "ledgr_sweep_retention" "list"