diff --git a/man/appearances.Rd b/man/appearances.Rd new file mode 100644 index 0000000..7bbefce --- /dev/null +++ b/man/appearances.Rd @@ -0,0 +1,67 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/appearances.R +\docType{data} +\name{appearances} +\alias{appearances} +\title{Appearances} +\format{ +A data frame with 22 variables: +\describe{ +\item{key_id}{\code{integer}. The unique ID number for the observation.} +\item{season_id}{\code{text}. The unique ID number for the season. +References \code{season_id} in the \code{seasons} dataset.} +\item{season}{\code{integer}. The year that the season started.} +\item{tier}{\code{integer}. The tier in English football. The possible +values are \code{1} through \code{4}.} +\item{division}{\code{test}. The division in English football. For the +current league structure, the possible values are \code{Premier League}, +\code{Championship}, \code{League One}, and \code{League Two}. For previous +league structures, the possible values are \code{First Division}, +\code{Second Division}, \code{Third Division}, and \code{Fourth Division}.} +\item{subdivision}{\code{test}. The subdivision in English football. In the +third tier, from the 1921-22 season through the 1957-58 season, there were +North and South subdivisions. The possible values are \code{North}, +\code{South}, and \code{None}.} +\item{match_id}{\code{text}. The unique ID number for the match. References +\code{match_id} in the \code{matches} dataset.} +\item{match_name}{\code{text}. The name of the match.} +\item{team_id}{\code{text}. The unique ID number for the team. References +\code{team_id} in the \code{teams} dataset.} +\item{team_name}{\code{text}. The name of the team.} +\item{opponent_id}{\code{text}. The unique ID number for the team's +opponent. References \code{team_id} in the \code{teams} dataset.} +\item{opponent_name}{\code{text}. The name of the team's opponent.} +\item{home_team}{\code{boolean}. Whether the team was the home team. Coded +\code{1} if the team was the home team and \code{0} otherwise.} +\item{away_team}{\code{boolean}. Whether the team was the away team. Coded +\code{1} if the team was the away team and \code{0} otherwise.} +\item{goals_for}{\code{integer}. The number of goals scored by the team.} +\item{goals_against}{\code{integer}. The number of goals scored against the +team.} +\item{goal_difference}{\code{integer}. The team's goal difference.} +\item{result}{\code{enum}. The result of the match. The possible values are +\code{home team win}, \code{away team win}, and \code{draw}.} +\item{win}{\code{boolean}. Whether the team won the match. Coded \code{1} +if the team won the match and \code{0} otherwise.} +\item{lose}{\code{boolean}. Whether the team lost the match. Coded \code{1} +if the team lost the match and \code{0} otherwise.} +\item{draw}{\code{boolean}. Whether the match ended in a draw. Coded +\code{1} of the match ended in a draw and \code{0} otherwise.} +\item{points}{\code{integer}. The number of points the team earned from the +match. A team earns \code{0} points for a loss and \code{1} point for a +draw. From the 1888-89 season through the 1980-81 season, teams earned +\code{2} points for a win. Starting with the 1981-82 season, teams have +earned \code{3} points for a win.} +} +} +\usage{ +appearances +} +\description{ +This dataset records all appearances. There is one observation per team per +match per season. It indicates whether the team is the home team or the +away team, the number of goals for and against, the goal difference, +whether the team wins, loses, or draws, and how many points the team earned +from the match. +} +\keyword{datasets} diff --git a/man/matches.Rd b/man/matches.Rd new file mode 100644 index 0000000..910f75c --- /dev/null +++ b/man/matches.Rd @@ -0,0 +1,67 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/matches.R +\docType{data} +\name{matches} +\alias{matches} +\title{Matches} +\format{ +A data frame with 21 variables: +\describe{ +\item{key_id}{\code{integer}. The unique ID number for the observation.} +\item{season_id}{\code{text}. The unique ID number for the season. +References \code{season_id} in the \code{seasons} dataset.} +\item{season}{\code{integer}. The year that the season started.} +\item{tier}{\code{integer}. The tier in English football. The possible +values are \code{1} through \code{4}.} +\item{division}{\code{test}. The division in English football. For the +current league structure, the possible values are \code{Premier League}, +\code{Championship}, \code{League One}, and \code{League Two}. For previous +league structures, the possible values are \code{First Division}, +\code{Second Division}, \code{Third Division}, and \code{Fourth Division}.} +\item{subdivision}{\code{test}. The subdivision in English football. In the +third tier, from the 1921-22 season through the 1957-58 season, there were +North and South subdivisions. The possible values are \code{North}, +\code{South}, and \code{None}.} +\item{match_id}{\code{text}. The unique ID number for the match. Has the +format \code{M-####-###}, where the first number is the season and second +number is a within-season counter that is assigned with the data sorted by +the name of the home team, then by the name of the away team.} +\item{match_name}{\code{text}. The name of the match.} +\item{home_team_id}{\code{text}. The unique ID number for the home team. +References \code{team_id} in the \code{teams} dataset.} +\item{home_team_name}{\code{text}. The name of the home team. See the +\code{teams} dataset.} +\item{away_team_id}{\code{text}. The unique ID number for the away team. +References \code{team_id} in the \code{teams} dataset.} +\item{away_team_name}{\code{text}. The name of the away team. See the +\code{teams} dataset.} +\item{score}{\code{text}. The score of the match in the format \code{#-#}, +where the first number is the score of the home team and the second number +is the score of the away team.} +\item{home_team_score}{\code{integer}. The score of the home team.} +\item{away_team_score}{\code{integer}. The score of the away team.} +\item{home_team_score_margin}{\code{integer}. The score margin for the home +team.} +\item{away_team_score_margin}{\code{integer}. The score margin for the away +team.} +\item{result}{\code{enum}. The result of the match. The possible values are +\code{home team win}, \code{away team win}, and \code{draw}.} +\item{home_team_win}{\code{boolean}. Whether the home team won the match. +Coded \code{1} if the home team won the match and \code{0} otherwise.} +\item{away_team_win}{\code{boolean}. Whether the home team won the match. +Coded \code{1} if the home team won the match and \code{0} otherwise.} +\item{draw}{\code{boolean}. Whether the match ended in a draw. Coded +\code{1} of the match ended in a draw and \code{0} otherwise.} +} +} +\usage{ +matches +} +\description{ +This dataset records all matches that have ever been played in the English +Football League and the Premier League (1888-2022). There is one +observation per match per season. It indicates the season, tier, division, +and subdivision for the match, the score, the score margin for each team, +and the result of the match (home team win, away team win, draw). +} +\keyword{datasets} diff --git a/man/seasons.Rd b/man/seasons.Rd new file mode 100644 index 0000000..23b4446 --- /dev/null +++ b/man/seasons.Rd @@ -0,0 +1,43 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/seasons.R +\docType{data} +\name{seasons} +\alias{seasons} +\title{Seasons} +\format{ +A data frame with 8 variables: +\describe{ +\item{key_id}{\code{integer}. The unique ID number for the observation.} +\item{season_id}{\code{text}. The unique ID number for the season. Has the +format \code{S-####-#}, where the first number is the year in which the +season started, the second number is the tier. In the third tier, from the +1921-22 season through the 1957-58 season, there were North and South +subdivisions. These are indicated by a \code{-N} or \code{-S} suffix.} +\item{season}{\code{integer}. The year that the season started.} +\item{tier}{\code{integer}. The tier in English football. The possible +values are \code{1} through \code{4}.} +\item{division}{\code{text}. The division in English football. For the +current league structure, the possible values are \code{Premier League}, +\code{Championship}, \code{League One}, and \code{League Two}. For previous +league structures, the possible values are \code{First Division}, +\code{Second Division}, \code{Third Division}, and \code{Fourth Division}.} +\item{subdivision}{\code{text}. The subdivision in English football. In the +third tier, from the 1921-22 season through the 1957-58 season, there were +North and South subdivisions. The possible values are \code{North}, +\code{South}, and \code{None}.} +\item{winner}{\code{text}. The name of the team that won the league.} +\item{count_teams}{\code{integer}. The number of teams in the league (that +actually played a match).} +} +} +\usage{ +seasons +} +\description{ +This dataset records all seasons in the English Football League and the +Premier League from inaugural season of the Football League (1888-89) +through the most recent season (2021-22). There is one observation per +season. It indicates the tier, division, subdivision, winner, and number of +teams for each season. +} +\keyword{datasets} diff --git a/man/standings.Rd b/man/standings.Rd new file mode 100644 index 0000000..9d698e8 --- /dev/null +++ b/man/standings.Rd @@ -0,0 +1,55 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/standings.R +\docType{data} +\name{standings} +\alias{standings} +\title{Standings} +\format{ +A data frame with 18 variables: +\describe{ +\item{key_id}{\code{integer}. The unique ID number for the observation.} +\item{season_id}{\code{text}. The unique ID number for the season. +References \code{season_id} in the \code{seasons} dataset.} +\item{season}{\code{integer}. The year that the season started.} +\item{tier}{\code{integer}. The tier in English football. The possible +values are \code{1} through \code{4}.} +\item{division}{\code{test}. The division in English football. For the +current league structure, the possible values are \code{Premier League}, +\code{Championship}, \code{League One}, and \code{League Two}. For previous +league structures, the possible values are \code{First Division}, +\code{Second Division}, \code{Third Division}, and \code{Fourth Division}.} +\item{subdivision}{\code{test}. The subdivision in English football. In the +third tier, from the 1921-22 season through the 1957-58 season, there were +North and South subdivisions. The possible values are \code{North}, +\code{South}, and \code{None}.} +\item{position}{\code{integer}. The team's final position in the league.} +\item{team_id}{\code{text}. The unique ID number for the team. References +\code{team_id} in the \code{teams} dataset.} +\item{team_name}{\code{text}. The name of the team.} +\item{played}{\code{integer}. The number of matches that the team played.} +\item{wins}{\code{integer}. The number of matches that the team won.} +\item{draws}{\code{integer}. The number of matches that the team drew.} +\item{losses}{\code{integer}. The number of matches that the team lost.} +\item{goals_for}{\code{integer}. The number of goals scored by the team.} +\item{goals_against}{\code{integer}. The number of goals scored against the +team.} +\item{goal_difference}{\code{integer}. The team's goal difference.} +\item{points}{\code{integer}. The number of points that the team earned +over the whole season (after any point adjustments).} +\item{point_adjustment}{\code{integer}. The number of points that were +deducted by the league due to violations of league rules or added by the +league due to forfeits.} +} +} +\usage{ +standings +} +\description{ +This dataset records all end-of-the-season standings. There is one +observation per team per season. It indicates the final position of the +team (accounting for tie-breakers), the name of the team, the number of +matches played, the number of wins, the number of losses, the number of +draws, the number of goals for, the number of goals against, the goal +difference, and the total number of points earned. +} +\keyword{datasets} diff --git a/man/teams.Rd b/man/teams.Rd new file mode 100644 index 0000000..ba77af7 --- /dev/null +++ b/man/teams.Rd @@ -0,0 +1,42 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/teams.R +\docType{data} +\name{teams} +\alias{teams} +\title{Teams} +\format{ +A data frame with 8 variables: +\describe{ +\item{key_id}{\code{integer}. The unique ID number for the observation.} +\item{team_id}{\code{text}. The unique ID number for the team. Has the +format \code{T-###}, where the number is a counter that is assigned with +the data sorted by the year of the team's first appearance in the Football +League and then by the team's name.} +\item{team_name}{\code{text}. The current name of the team.} +\item{former_team_names}{\code{text}. The former names of the team, +separated by a comma. Coded \code{None} for teams that have not changed +their name.} +\item{current}{\code{boolean}. Whether the team currently competes in the +English Football League or the Premier League. Coded \code{1} if the team +currently competes in these leagues and \code{0} otherwise.} +\item{former}{\code{boolean}. Whether the team no longer competes in the +English Football League or the Premier League (but still exists). Coded +\code{1} if the team is no longer in these leagues and \code{0} otherwise.} +\item{defunct}{\code{boolean}. Whether the team is defunct and no longer +exists. Coded \code{1} if the team is defunct and \code{0} otherwise.} +\item{first_appearance}{\code{integer}. The season that the team first +competed in the Football League.} +} +} +\usage{ +teams +} +\description{ +This dataset records all teams who have competed in the English Football +League and the Premier League. There is one observation per team. It +indicates the current name of the team, any former names of the team, +whether the team is a former member of the Football League, whether the +team is defunct, and the season that the team made their first appearance +in the Football League. +} +\keyword{datasets}