select_group

Documentation for eth_defi.vault_report.sections.select_group function.

select_group(eligible_df, criteria, group, *, by='one_month_cagr_best')

Select the best vaults of a vault group.

The selector of every best-performing section in eth_defi.vault_report.post.BEST_SECTIONS: the table with by the section’s table metric, one-month return or three-month Sharpe, and the performance chart with by CHART_RETURN. The result is not truncated, so the investability check can take deeper candidate lists from the same ranking.

Applies the TVL threshold, ReportCriteria.amm_min_tvl for AMM pools, and the activity threshold for lending, RWA and other vaults. Perpetual futures DEX vaults and tokenised funds have no comparable onchain deposit events, and AMM pools have the higher TVL threshold instead. Vaults without the ranking metric are dropped, because a table or chart cannot place them.

Parameters

• eligible_df (pandas.DataFrame) – Comparable vaults, see select_comparable_vaults(), with group, current_nav, event_count and the by column. AMM pools must still be included, as their own section uses this.

• criteria (eth_defi.vault_report.sections.ReportCriteria) – Report thresholds.

• group (str) – Vault group, see classify_vault().

• by (str) – Ranking metric column.

Returns

All matching vaults, best first, not truncated.

Return type

pandas.DataFrame