Skip to contents

ledgr_sweep_review() packages the common sweep-inspection shape into a small list of tables. It ranks completed candidates by an explicit expression, returns the top rows, and separates failed or warning-bearing rows for review. It does not select or promote a candidate.

Usage

ledgr_sweep_review(sweep, rank_by, n = 5L)

# S3 method for class 'ledgr_sweep_review'
print(x, ...)

Arguments

sweep

A ledgr_sweep_results object, reopened sweep, or compatible tibble-like candidate table.

rank_by

Ranking expression evaluated against completed candidate rows. Use desc(metric) or -metric for descending numeric rankings.

n

Number of top completed candidates to keep in top.

x

A ledgr_sweep_review object.

...

Passed to the tibble print methods for the review tables.

Value

A ledgr_sweep_review list with ranked, top, issues, rank_by, and n.

Examples

if (FALSE) { # \dontrun{
review <- ledgr_sweep_review(sweep, rank_by = desc(sharpe_ratio), n = 5)
review$top
review$issues
} # }