monashtipr
The goal of monashtipr
is to provide an R based API that allows users
to submit tips to the Monash University Probabilistic Footy Tipping
Competition from R.
Installation
Install the released version of monashtipr
from CRAN:
install.packages("monashtipr")
And the development version from GitHub with:
# install.packages("devtools")
devtools::install_github("jimmyday12/monashtipr")
Workflow
The two main functions are get_games()
and submit_tips
. The general
workflow is to use get_games()
to grab a data frame of the games from
a particular round, edit/add your tips and then submit them to the
Monash website using submit_tips
.
First we pull down the games. I’ve chosen to store my password and username in an Renviron file here to keep them secret, but you could pass these in via plain text. Read up on options for this here
library(monashtipr)
# Store password and username
# If wanted - store user/password in Renviron file
# e.g. you can run `usethis::edit_r_environ()` and edit them
# MONASH_USER = xxx
# MONASH_PASS = xxx
user <- Sys.getenv("MONASH_USER")
pass = Sys.getenv("MONASH_PASS")
Now we can pull games.
comp = "normal"
games <- get_games(user, pass, comp = comp)
#> Login succesfull!
#> Returning current rounds games below...
games
#> # A tibble: 9 × 5
#> Game Ground Home Away Margin
#> <int> <chr> <chr> <chr> <lgl>
#> 1 1 Marvel Stadium W_Bulldogs Carlton NA
#> 2 2 SCG Sydney Geelong NA
#> 3 3 MCG Collingwood Adelaide NA
#> 4 4 Marvel Stadium Essendon Brisbane NA
#> 5 5 Adelaide Oval P_Adelaide Hawthorn NA
#> 6 6 Metricon Stadium Gold_Coast Melbourne NA
#> 7 7 Marvel Stadium Kangaroos W_Coast NA
#> 8 8 MCG Richmond G_W_Sydney NA
#> 9 9 Optus Stadium Fremantle St_Kilda NA
Next - we edit the games data frame to add our tips. How you do this will vary by how you actually store your tips - you might do a join with your existing model output for example. I’ll leave that up to the user. A simple example would be to provide a vector of margins.
Please note - these should always be the margin tip of the HOME TEAM.
games$Margin <- c(1, 6, 4, 4, 20, -1, -2, -12, -7)
games
#> # A tibble: 9 × 5
#> Game Ground Home Away Margin
#> <int> <chr> <chr> <chr> <dbl>
#> 1 1 Marvel Stadium W_Bulldogs Carlton 1
#> 2 2 SCG Sydney Geelong 6
#> 3 3 MCG Collingwood Adelaide 4
#> 4 4 Marvel Stadium Essendon Brisbane 4
#> 5 5 Adelaide Oval P_Adelaide Hawthorn 20
#> 6 6 Metricon Stadium Gold_Coast Melbourne -1
#> 7 7 Marvel Stadium Kangaroos W_Coast -2
#> 8 8 MCG Richmond G_W_Sydney -12
#> 9 9 Optus Stadium Fremantle St_Kilda -7
Now we just pass this back with our original credentials and we are good to go!
submit_tips(games, user, pass, comp = comp)
#> Login succesfull!
#> # A tibble: 9 × 4
#> Game Team Margin Status
#> <int> <chr> <int> <chr>
#> 1 1 W_Bulldogs 1 Updated.
#> 2 2 Sydney 6 Updated.
#> 3 3 Collingwood 4 Updated.
#> 4 4 Essendon 4 Updated.
#> 5 5 P_Adelaide 20 Updated.
#> 6 6 Melbourne 1 Updated.
#> 7 7 W_Coast 2 Updated.
#> 8 8 G_W_Sydney 12 Updated.
#> 9 9 St_Kilda 7 Updated.
Code of Conduct
Please note that the monashtipr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.