Index of /web/packages/ffscrapr/readme

[ICO]NameLast modifiedSizeDescription
[PARENTDIR]Parent Directory  -  
[DIR]man/2020-08-17 18:40 -  
[TXT]README.html2020-08-17 18:40 14K 
README

ffscrapr

An R Client for Fantasy Football League APIs

CRAN status Lifecycle: maturing Codecov test coverage R build status

Helps access various Fantasy Football APIs (i.e. MFL, Sleeper, Fleaflicker, ESPN, Yahoo, potentially other platforms) by handling authentication and rate-limiting, forming appropriate calls, and returning tidy dataframes which can be easily connected to other data sources.

Installation

Install from GitHub with:

# install.packages("devtools") OR install.packages("remotes")
## remotes is a subpackage of devtools
remotes::install_github("dynastyprocess/ffscrapr")

Usage

All ffscrapr functions start with a connection object created by ff_connect, which stores connection, authentication, and other user-defined parameters. This object is used by all other functions to help return the correct data.

library(ffscrapr)
ssb <- ff_connect(platform = "mfl", league_id = "54040", season = 2020)

# Get a summary of league settings
ff_league(ssb) %>% str()
#> tibble [1 x 13] (S3: tbl_df/tbl/data.frame)
#>  $ league_id      : chr "54040"
#>  $ league_name    : chr "The Super Smash Bros Dynasty League"
#>  $ franchise_count: num 14
#>  $ qb_type        : chr "1QB"
#>  $ idp            : logi FALSE
#>  $ scoring_flags  : chr "0.5_ppr, TEPrem, PP1D"
#>  $ best_ball      : logi TRUE
#>  $ salary_cap     : logi FALSE
#>  $ player_copies  : num 1
#>  $ years_active   : chr "2018-2020"
#>  $ qb_count       : chr "1"
#>  $ roster_size    : num 35
#>  $ league_depth   : num 490

# Get rosters
ff_rosters(ssb)
#> # A tibble: 429 x 11
#>    franchise_id franchise_name player_id player_name pos   team    age
#>    <chr>        <chr>          <chr>     <chr>       <chr> <chr> <dbl>
#>  1 0001         Team Pikachu   13129     Fournette,~ RB    JAC    25.6
#>  2 0001         Team Pikachu   13189     Engram, Ev~ TE    NYG    25.9
#>  3 0001         Team Pikachu   11680     Landry, Ja~ WR    CLE    27.7
#>  4 0001         Team Pikachu   13290     Cohen, Tar~ RB    CHI    25  
#>  5 0001         Team Pikachu   13155     Ross, John  WR    CIN    24.7
#>  6 0001         Team Pikachu   13158     Westbrook,~ WR    JAC    26.7
#>  7 0001         Team Pikachu   10273     Newton, Cam QB    NEP    31.2
#>  8 0001         Team Pikachu   14085     Pollard, T~ RB    DAL    23.3
#>  9 0001         Team Pikachu   13139     Williams, ~ RB    GBP    25.4
#> 10 0001         Team Pikachu   13649     Hamilton, ~ WR    DEN    25.4
#> # ... with 419 more rows, and 4 more variables: roster_status <chr>,
#> #   drafted <chr>, draft_year <chr>, draft_round <chr>

# Get transactions
ff_transactions(ssb)
#> # A tibble: 183 x 12
#>    timestamp           type  type_desc franchise_id franchise_name player_id
#>    <dttm>              <chr> <chr>     <chr>        <chr>          <chr>    
#>  1 2020-08-10 16:32:55 FREE~ dropped   0013         Team Ness      11925    
#>  2 2020-08-10 16:31:43 FREE~ dropped   0013         Team Ness      12648    
#>  3 2020-08-07 20:38:52 IR    activated 0007         Team Kirby     13871    
#>  4 2020-08-06 17:01:09 IR    deactiva~ 0003         Team Captain ~ 10737    
#>  5 2020-08-06 17:01:09 IR    deactiva~ 0003         Team Captain ~ 11758    
#>  6 2020-08-06 17:01:09 IR    deactiva~ 0003         Team Captain ~ 11890    
#>  7 2020-08-04 22:16:11 IR    deactiva~ 0013         Team Ness      11925    
#>  8 2020-08-04 16:22:07 FREE~ dropped   0013         Team Ness      11850    
#>  9 2020-08-03 20:34:25 IR    activated 0007         Team Kirby     13724    
#> 10 2020-08-03 20:33:17 IR    deactiva~ 0007         Team Kirby     12665    
#> # ... with 173 more rows, and 6 more variables: player_name <chr>, pos <chr>,
#> #   team <chr>, bbid_spent <dbl>, trade_partner <chr>, comments <chr>

For a more detailed usage example, including a template dynasty league analysis script, please check out the reference articles and/or vignettes!

Contributing

Many hands make light work! Here are some ways you can contribute to this project:

Terms of Use

The R code for this package is released as open source under the MIT license.

The APIs and data accessed by this package belong to their respective owners, and are governed by their terms of use.