Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix spelling in documentation and README #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix spelling in documentation and README #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The database contains `5` datasets: `seasons`, `teams`, `matches`, `appearances`

The Fjelstul English Football Database is available via the `R` package `englishfootball`, which you can install from this repository (instructions below). Note that this repository is structured as a repository for an `R` package. You can also download the database directly from this repository in `3` formats: an `.RData` version of the database is available in the `data/` folder, a `.csv` version is available in the `data-csv/` folder, and a relational database version (`SQLite`) is available in the `data-sqlite/` folder.

The `.Rdata` and `.csv` versions of the database are all identical except for the file format. These versions of the database are not technically relational because some tables already include variables that have been merged in from other tables for convenience (i.e., some data exists in multiple tables). The `SQLite` version includes all of the same variables, but variables from other tables are not already merged in. Dummy variables that are coded `0` or `1` are converted to `FALSE` and `TRUE`. Users can use the primary and foreign keys in the tables to merge in data from other tables. See the `SQL-schema.txt` file in the `data-sqlite/` folder for more details.
The `.RData` and `.csv` versions of the database are all identical except for the file format. These versions of the database are not technically relational because some tables already include variables that have been merged in from other tables for convenience (i.e., some data exists in multiple tables). The `SQLite` version includes all of the same variables, but variables from other tables are not already merged in. Dummy variables that are coded `0` or `1` are converted to `FALSE` and `TRUE`. Users can use the primary and foreign keys in the tables to merge in data from other tables. See the `SQL-schema.txt` file in the `data-sqlite/` folder for more details.

## Downloading the codebook

Expand Down Expand Up @@ -38,7 +38,7 @@ The data in the Fjelstul English Football Database is coded based on information

- **Team names.** Many team names end in `Football Club`, usually abbreviated as `F.C.`, and a few start with `AFC` (Athletic Football Club). I standardize team names throughout the database by removing these abbreviations. Some teams have changed their names over time. For example, Manchester United started out as Newton Heath and Arsenal started out as Woolwich Arsenal. The `matches`, `appearances`, and `standings` datasets always use the name of the team at the time. The `team_name` variable in the `teams` dataset is the current name of the team, and the `former_team_names` variable in the `teams` dataset lists any previous names. The `team_id` variable and its extensions, such as `home_team_id` and `away_team_id`, allow you to track teams across name changes in the `matches`, `appearances`, and `standings` datasets. For example, in the `matches` dataset, `team_name` will be coded `Newton Heath` before the name change and `Manchester United` after the name change, but `team_id` will have the same value for both.

- **Defunct teams.** Some teams that have been in the English Football League have been relegated and are currently playing in lower divisons. There are also some teams that have become defunct. The `defunct` variable in the `teams` dataset indicates teams that have become defunct and no longer exist. I do not code teams that have since been revived as defunct, regardless of whether they are current members of the English Football League. There are `27` defunct teams that have not been revived.
- **Defunct teams.** Some teams that have been in the English Football League have been relegated and are currently playing in lower divisions. There are also some teams that have become defunct. The `defunct` variable in the `teams` dataset indicates teams that have become defunct and no longer exist. I do not code teams that have since been revived as defunct, regardless of whether they are current members of the English Football League. There are `27` defunct teams that have not been revived.

- **Phoenix teams.** Sometimes, a team will be dissolved, and then a new team will be created with the same name as a revival of the original team. These are called phoenix teams, and I code them as a continuation of the original team, even though legally, they are a new entity. For example, I code the current Accrington Stanley as a continuation of the Accrington Stanley that was founded in 1891 and was later dissolved. Similarly, Bradford Pack Avenue was dissolved and was then later revived. One unusual case is Wimbledon. Wimbledon F.C. was relocated and became Milton Keynes Dons F.C., which I code as a separate team. Then, a protest club called AFC Wimbledon was founded to replace the original Wimbledon F.C. I code the new Wimbledon as a revival of the original Wimbledon. Accounting for phoenix teams, there have been `144` unique teams in the Premier League and English Football League.

Expand Down Expand Up @@ -86,4 +86,4 @@ The `BibTeX` entry for the `R` package is:

## Reporting problems

If you notice an error in the data or a bug in the `R` package, please report it [here](https://github.com/jfjelstul/englishfotoball/issues).
If you notice an error in the data or a bug in the `R` package, please report it [here](https://github.com/jfjelstul/englishfootball/issues).
4 changes: 2 additions & 2 deletions codebook/csv/variables.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ dataset_id,dataset,variable_id,variable,type,description
3,matches,17,away_team_score_margin,integer,The score margin for the away team.
3,matches,18,result,enum,"The result of the match. The possible values are {home team win}, {away team win}, and {draw}."
3,matches,19,home_team_win,boolean,Whether the home team won the match. Coded {1} if the home team won the match and {0} otherwise.
3,matches,20,away_team_win,boolean,Whether the home team won the match. Coded {1} if the home team won the match and {0} otherwise.
3,matches,20,away_team_win,boolean,Whether the away team won the match. Coded {1} if the away team won the match and {0} otherwise.
3,matches,21,draw,boolean,Whether the match ended in a draw. Coded {1} of the match ended in a draw and {0} otherwise.
4,appearances,1,key_id,integer,The unique ID number for the observation.
4,appearances,2,season_id,text,The unique ID number for the season. References {season_id} in the {seasons} dataset.
Expand Down Expand Up @@ -75,4 +75,4 @@ dataset_id,dataset,variable_id,variable,type,description
5,standings,15,goals_against,integer,The number of goals scored against the team.
5,standings,16,goal_difference,integer,The team's goal difference.
5,standings,17,points,integer,The number of points that the team earned over the whole season (after any point adjustments).
5,standings,18,point_adjustment,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.
5,standings,18,point_adjustment,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.