ps_streaks_get_max_rank: ps_streaks_get_max_rank

View source: R/mod_plot_functions_max_rank.R

ps_streaks_get_max_rankR Documentation

ps_streaks_get_max_rank

Description

Given a year range and a list of teams and a value n, find an estimate of the maximum of the nth highest rank over all intensity levels.

Usage

ps_streaks_get_max_rank(lzy_streaks, n, min_year, max_year, teams, hot)

Arguments

lzy_streaks

Lazy streaks table

n

Function will maximize value of nth highest rank

min_year

Minimum year for filter

max_year

Maximum year for filter

teams

Vector of team IDs for filter.

hot

If TRUE use hot streaks, otherwise cold streaks

Details

This function is a wrapper around ps_streaks_get_max_rank_simple and ps_streaks_get_max_rank_by_sampling and will decide the appropriate function and parameters to use based on the number of years and the number of teams.

Value

Max value estimate


tor-gu/streakexplorer documentation built on Aug. 2, 2022, 8:22 p.m.