From 07894b4fb618e97ce6099c24b0299895dcf7ba09 Mon Sep 17 00:00:00 2001 From: Thomas Mock Date: Mon, 16 Mar 2020 13:59:46 -0500 Subject: [PATCH] remove examples and duplicate manual --- ...t_espn_college_qbr.Rd => get_college_qbr.Rd} | 10 ++++++---- man/get_espn_standings.Rd | 17 ----------------- man/get_nfl_qbr.Rd | 6 ++---- ...pn_nfl_standings.Rd => get_nfl_standings.Rd} | 12 +++++++----- man/scrape_espn_stats.Rd | 6 +++--- 5 files changed, 18 insertions(+), 33 deletions(-) rename man/{get_espn_college_qbr.Rd => get_college_qbr.Rd} (67%) delete mode 100644 man/get_espn_standings.Rd rename man/{get_espn_nfl_standings.Rd => get_nfl_standings.Rd} (62%) diff --git a/man/get_espn_college_qbr.Rd b/man/get_college_qbr.Rd similarity index 67% rename from man/get_espn_college_qbr.Rd rename to man/get_college_qbr.Rd index c8b22e3..4abbc20 100644 --- a/man/get_espn_college_qbr.Rd +++ b/man/get_college_qbr.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/scrape_college_espn_qbr.R -\name{get_espn_college_qbr} -\alias{get_espn_college_qbr} +\name{get_college_qbr} +\alias{get_college_qbr} \title{Get ESPN QBR for College football} \usage{ -get_espn_college_qbr(season = 2019, week = NA) +get_college_qbr(season = 2019, week = NA) } \arguments{ \item{season}{Numeric or character - greater than 2004} @@ -19,8 +19,10 @@ Get ESPN QBR for College football } \examples{ +# Get college QBR from 2011 season as a whole get_college_qbr(season = 2011, week = NA) -get_espn_college_qbr(2019, 1) +# Get college QBR from 2019 season week 1 +get_college_qbr(2019, 1) } diff --git a/man/get_espn_standings.Rd b/man/get_espn_standings.Rd deleted file mode 100644 index b76581a..0000000 --- a/man/get_espn_standings.Rd +++ /dev/null @@ -1,17 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/get_espn_standings.R -\name{get_espn_standings} -\alias{get_espn_standings} -\title{Collect NFL standings for a specific season from ESPN's API} -\usage{ -get_espn_standings(season = 2019) -} -\arguments{ -\item{season}{Either numeric or character} -} -\value{ -Returns a tibble -} -\description{ -Collect NFL standings for a specific season from ESPN's API -} diff --git a/man/get_nfl_qbr.Rd b/man/get_nfl_qbr.Rd index fefa1b9..587c6cc 100644 --- a/man/get_nfl_qbr.Rd +++ b/man/get_nfl_qbr.Rd @@ -20,12 +20,10 @@ Returns a tibble Get ESPN QBR for NFL football } \examples{ +# Get ALL Playoff QBR from 2016 season get_nfl_qbr("2016", season_type = "Playoffs", week = NA) -all_superbowls <- tidyr::crossing(season = 2006:2019, season_type = "Playoffs", week = 4) \%>\% -dplyr::filter(season != 2017) \%>\% -purrr::pmap_dfr(get_nfl_qbr) - +# Get Regular season QBR for week 4 of 2019 get_nfl_qbr("2019", season_type = "Regular", week = 4) } diff --git a/man/get_espn_nfl_standings.Rd b/man/get_nfl_standings.Rd similarity index 62% rename from man/get_espn_nfl_standings.Rd rename to man/get_nfl_standings.Rd index 54c1f60..871b213 100644 --- a/man/get_espn_nfl_standings.Rd +++ b/man/get_nfl_standings.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/espn_api_standings.R -\name{get_espn_nfl_standings} -\alias{get_espn_nfl_standings} +\name{get_nfl_standings} +\alias{get_nfl_standings} \title{Get NFL standings for a specific season from ESPN's API} \usage{ -get_espn_nfl_standings(season = 2019) +get_nfl_standings(season = 2019) } \arguments{ \item{season}{Either numeric or character} @@ -16,8 +16,10 @@ Returns a tibble Get NFL standings for a specific season from ESPN's API } \examples{ -get_espn_nfl_standings(season = "2018") +# Get standings from 2018 season +get_nfl_standings(season = "2018") -get_espn_nfl_standings(2010) +# Get standings from 2010 season +get_nfl_standings(2010) } diff --git a/man/scrape_espn_stats.Rd b/man/scrape_espn_stats.Rd index 9a3ed8b..8b1767c 100644 --- a/man/scrape_espn_stats.Rd +++ b/man/scrape_espn_stats.Rd @@ -4,13 +4,13 @@ \alias{scrape_espn_stats} \title{Scrape NFL stats from ESPN} \usage{ -scrape_espn_stats(stat = "receiving", season = 2019, season_type = "Regular") +scrape_espn_stats(season = 2019, stat = "receiving", season_type = "Regular") } \arguments{ -\item{stat}{character - either receiving, passing, or rushing} - \item{season}{character or numeric - greater than 1990} +\item{stat}{character - either receiving, passing, or rushing} + \item{season_type}{character - either Regular or Playoffs} } \value{