Skip to content

Commit 1730c79

Browse files
committed
docs(Statcast): Add runner_extra_bases_taken function documentation
1 parent a09e340 commit 1730c79

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

docs/runner_extra_bases_taken.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Statcast Runner Extra Bases Taken
2+
3+
## `runner_extra_bases_taken`
4+
5+
Function to get extra base taken data from each advanced opportunity for a specific runner. Based on Baseball Savant's [Runner Extra Bases Taken](https://baseballsavant.mlb.com/leaderboard/baserunning).
6+
7+
**Examples**
8+
9+
```python
10+
from baseball_stats_python import runner_extra_bases_taken
11+
12+
# Get Corbin Carroll's runner extra bases taken data
13+
runner_extra_bases_taken('682998')
14+
15+
# Get Corbin Carroll's runner extra bases taken data in 2023
16+
runner_extra_bases_taken('682998', season='2023')
17+
18+
# Get Corbin Carroll's runner extra bases taken data in playoffs
19+
runner_extra_bases_taken('682998', game_type=GameType.PLAYOFFS)
20+
```
21+
22+
**Arguments**
23+
24+
| Argument | Data Type | Description |
25+
| -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| runner_id (Required) | `str` | The MLBAM ID of the runner. |
27+
| game_type | `str` or `GameType` | The game type to filter by. Can be `R` for regular season, `PO` for playoffs, or `All` for all games. Check enum [GameType](../enums/statcast_leaderboard.py) |
28+
| season | `str` | The season to filter by. The earliest season available is 2016. |
29+
30+
**Return**
31+
32+
A DataFrame with columns that related to the [Runner Extra Bases Taken](https://baseballsavant.mlb.com/leaderboard/baserunning) leaderboard. The DataFrame will represent each advanced opportunity for a specific runner which contains data like `fielder_runs`, `runner_runs`, `base_out_text`, etc.

0 commit comments

Comments
 (0)