worldfootballR

https://jaseziv.github.io/worldfootballR/
Admin
This package is designed to allow users to extract various world football results and player...
Tokens:58,547
Snippets:599
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Usage of get_match_lineups

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_lineups.html

Demonstrates how to get a match URL and then use `get_match_lineups` to retrieve the lineups. This example is wrapped in a try-catch block for error handling and is set to not run by default.

```R
if (FALSE) { # \dontrun{
try({
match <- get_match_urls(country = "AUS", gender = "F", season_end_year = 2021, tier = "1st")[1]
df <- get_match_lineups(match_url = match)
})
} # }
```

--------------------------------

### Example: Get Defensive Stats for Italian League

Source: https://jaseziv.github.io/worldfootballR/reference/fb_season_team_stats.html

Demonstrates how to call the function to get 'defense' statistics for the Italian men's top league in the 2021 season. This example is wrapped in a try-catch block for error handling and is designed to be run conditionally.

```R
if (FALSE) { # \dontrun{
try({
fb_season_team_stats("ITA", "M", 2021, "1st", "defense")
})
} # }

```

--------------------------------

### Example: Get Match URLs for Multiple Seasons

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_urls.html

Demonstrates how to retrieve match URLs for multiple seasons of a specific league. This example is wrapped in a \dontrun{} block to prevent accidental execution.

```R
if (FALSE) { # \dontrun{
try({
get_match_urls(country = "ENG", gender = "M", season_end_year = c(2019:2021), tier = "1st")
})
}

```

--------------------------------

### Example: Get Match URLs for Non-Domestic League

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_urls.html

Shows how to fetch match URLs for a non-domestic competition by providing its specific URL. This example is wrapped in a \dontrun{} block.

```R
if (FALSE) { # } 

non_dom <- "https://fbref.com/en/comps/218/history/Friendlies-M-Seasons"
get_match_urls(country = "", gender = "M", season_end_year = 2021, non_dom_league_url = non_dom)
})
}

```

--------------------------------

### Example: Get Match Results for Manchester City

Source: https://jaseziv.github.io/worldfootballR/reference/get_team_match_results.html

This example demonstrates how to use `get_team_match_results` to fetch match results for Manchester City. It includes error handling and is wrapped in a \dontrun{} block.

```r
if (FALSE) { # \dontrun{
try({
# for single teams:
man_city_url <- "https://fbref.com/en/squads/b8fd03ef/Manchester-City-Stats"
get_team_match_results(man_city_url)
})
} # }
```

--------------------------------

### Example: Fetching Manchester City Match Results

Source: https://jaseziv.github.io/worldfootballR/reference/fb_team_match_results.html

This example demonstrates how to use `fb_team_match_results` to get all match results for Manchester City. It includes error handling and is set to run only in non-interactive sessions.

```R
if (FALSE) { # \dontrun{
try({
# for single teams:
man_city_url <- "https://fbref.com/en/squads/b8fd03ef/Manchester-City-Stats"b_team_match_results(man_city_url)
})
} # }
```

--------------------------------

### Example: Get National Team Playing Time Stats for Multiple Players

Source: https://jaseziv.github.io/worldfootballR/reference/fb_player_season_stats.html

Fetches playing time statistics for multiple players from their national teams. This example demonstrates fetching data for multiple players and national teams.

```R
multiple_national_playing_time <- fb_player_season_stats(
    player_url = c(
      "https://fbref.com/en/players/d70ce98e/Lionel-Messi",
      "https://fbref.com/en/players/dea698d9/Cristiano-Ronaldo"
    ),
    stat_type = "playing_time",
    national = TRUE
  )
```

--------------------------------

### Example: Get Manchester City's goals for

Source: https://jaseziv.github.io/worldfootballR/reference/fb_team_goal_logs.html

Example of how to use `fb_team_goal_logs` to get goals scored by Manchester City. This example is wrapped in `try` and `if (FALSE)` to prevent execution during package checks.

```R
if (FALSE) { # \dontrun{
try({
# for single teams:
man_city_url <- "https://fbref.com/en/squads/b8fd03ef/Manchester-City-Stats"b_team_goal_logs(team_urls = man_city_url, for_or_against = "for")
})
} # }
```

--------------------------------

### Example: Get Player Shooting Stats for English League

Source: https://jaseziv.github.io/worldfootballR/reference/fb_league_stats.html

Demonstrates how to retrieve shooting statistics for individual players in the English 1st tier league for the 2022 season. This example is wrapped in a try-catch block for error handling.

```R
if (FALSE) { # \dontrun{
try({
fb_league_stats(
  country = "ENG",
  gender = "M",
  season_end_year = 2022,
  tier = "1st",
  stat_type = "shooting",
  team_or_player = "player"
)
## Non-domestic league
##   Note that this is more likely to fail due to the volume of players
fb_league_stats(
  country = NA_character_,
  gender = "M",
  season_end_year = 2023,
  tier = NA_character_,
  non_dom_league_url = "https://fbref.com/en/comps/8/history/Champions-League-Seasons",
  stat_type = "standard",
  team_or_player = "player"
)
})
} # }
```

--------------------------------

### Example: Get match lineups for a specific match

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_lineups.html

This example demonstrates how to fetch match lineups using the `fb_match_lineups` function. It first retrieves a match URL and then passes it to the function. The `try` block is used for error handling, and the `if (FALSE)` condition prevents execution during standard package checks.

```R
if (FALSE) { # \dontrun{
try({
match <- fb_match_urls(country = "AUS", gender = "F", season_end_year = 2021, tier = "1st")[1]
df <- fb_match_lineups(match_url = match)
})
} # }
```

--------------------------------

### Example Usage of Get Season Team Stats

Source: https://jaseziv.github.io/worldfootballR/reference/get_season_team_stats.html

Demonstrates how to call the `get_season_team_stats` function with specific parameters for Italian men's first-tier league defense statistics from the 2021 season. This example is wrapped in a try-catch block for error handling and is set to not run by default.

```R
if (FALSE) { # \dontrun{
try({
get_season_team_stats("ITA", "M", 2021, "1st", "defense")
})
} # }

```

--------------------------------

### Example: Get Passing Stats for Manchester City

Source: https://jaseziv.github.io/worldfootballR/reference/fb_team_match_log_stats.html

Demonstrates how to retrieve 'passing' statistics for a single team, Manchester City. Ensure the `try` block is used for robust execution.

```R
if (FALSE) { # \dontrun{
try({
# for single teams:
man_city_url <- "https://fbref.com/en/squads/b8fd03ef/Manchester-City-Stats"b_team_match_log_stats(team_urls = man_city_url, stat_type = "passing")
})
} # }
```

--------------------------------

### R Example: Get League Match URLs

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_urls.html

Demonstrates how to fetch match URLs for a specific country, gender, and a range of seasons. Use this for standard league data retrieval.

```R
fb_match_urls(country = "ENG", gender = "M", season_end_year = c(2019:2021), tier = "1st")
```

--------------------------------

### Example: Get Standard Player Stats

Source: https://jaseziv.github.io/worldfootballR/reference/fb_player_season_stats.html

Retrieves standard season statistics for a single player. Ensure the player URL is correct and the stat_type is valid.

```R
standard_stats <- fb_player_season_stats(
    "https://fbref.com/en/players/3bb7b8b4/Ederson",
    stat_type = "standard"
  )
```

--------------------------------

### Example: Get Playing Time Stats for Multiple Players

Source: https://jaseziv.github.io/worldfootballR/reference/fb_player_season_stats.html

Fetches playing time statistics for multiple players simultaneously. This is useful for comparing player performance across a season.

```R
multiple_playing_time <- fb_player_season_stats(
    player_url = c(
      "https://fbref.com/en/players/d70ce98e/Lionel-Messi",
      "https://fbref.com/en/players/dea698d9/Cristiano-Ronaldo"
    ),
    stat_type = "playing_time"
  )
```

--------------------------------

### Install Development Dependencies

Source: https://jaseziv.github.io/worldfootballR/CONTRIBUTING.html

Installs all necessary development dependencies for the package. Ensure this is done before running R CMD check.

```r
devtools::install_dev_deps()
```

--------------------------------

### Example: Get English Championship Men's Results

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_results.html

Retrieves results for the English Championship (2nd tier) for men in the 2021 season. Specify the `tier` argument as '2nd'.

```R
df <- get_match_results(country = "ENG", gender = "M", season_end_year = 2021, tier = "2nd")
```

--------------------------------

### Example: Fetching a Match Report

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_report.html

This example demonstrates how to fetch a match report using `fb_match_report`. It first retrieves a match URL using `fb_match_urls` and then passes it to `fb_match_report`. The code is wrapped in `try` and `if (FALSE)` for safe execution.

```R
if (FALSE) { # \dontrun{
try({
match <- fb_match_urls(country = "AUS", gender = "F", season_end_year = 2021, tier = "1st")[1]
df <- fb_match_report(match_url = match)
})
} # }
```

--------------------------------

### Example Usage of fb_league_urls

Source: https://jaseziv.github.io/worldfootballR/reference/fb_league_urls.html

Demonstrates how to call `fb_league_urls` to get league URLs for men's 1st tier leagues in England ending in 2021. The `try` block is used for error handling during execution.

```R
if (FALSE) { # \dontrun{
try({
fb_league_urls(country = "ENG", gender = "M", season_end_year = 2021, tier = '1st')
})
} # }
```

--------------------------------

### Example Usage of get_match_summary

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_summary.html

This example demonstrates how to use `get_match_summary` to retrieve match events. It first obtains a match URL and then passes it to the function. The `try` block is used for error handling.

```R
if (FALSE) { # \dontrun{
try({
match <- get_match_urls(country = "AUS", gender = "F", season_end_year = 2021, tier = "1st")[1]
df <- get_match_summary(match_url = match)
})
} # }
```

--------------------------------

### Example: Get Italian Men's League Results

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_results.html

Fetches results for the Italian men's league for the 2021 season. Ensure the `country` code is correctly formatted.

```R
df <- get_match_results(country = c("ITA"), gender = "M", season_end_year = 2021)
```

--------------------------------

### R Example: Fetching Match Shooting Data

Source: https://jaseziv.github.io/worldfootballR/reference/get_match_shooting.html

Example of how to use the `get_match_shooting` function to retrieve shooting data for a specific match. Ensure you have a valid match URL.

```R
if (FALSE) { # \dontrun{
try({
match <- "https://fbref.com/en/matches/bf52349b/Fulham-Arsenal-September-12-2020-Premier-League"
df <- get_match_shooting(match_url = match)
})
} # }
```

--------------------------------

### Install worldfootballR from GitHub

Source: https://jaseziv.github.io/worldfootballR/index.html

Installs the latest version of the worldfootballR package directly from GitHub using the devtools package. It is recommended to install from GitHub as the CRAN version may be outdated.

```R
# install.packages("devtools")
devtools::install_github("JaseZiv/worldfootballR")
```

--------------------------------

### Example: Get National Team Standard Stats

Source: https://jaseziv.github.io/worldfootballR/reference/fb_player_season_stats.html

Retrieves standard statistics for a player's national team performance. Set `national = TRUE` to fetch national team data instead of club data.

```R
national_standard_stats <- fb_player_season_stats(
    "https://fbref.com/en/players/3bb7b8b4/Ederson",
    stat_type = "standard",
    national = TRUE
  )
```

--------------------------------

### R Example: Get Non-Domestic League Match URLs

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_urls.html

Shows how to retrieve match URLs for non-domestic competitions by providing a specific URL. This is useful for cups and international tournaments.

```R
non_dom <- "https://fbref.com/en/comps/218/history/Friendlies-M-Seasons"b_match_urls(country = "", gender = "M", season_end_year = 2021, non_dom_league_url = non_dom)
```

--------------------------------

### Get match lineups

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Fetches the lineup data for a match, including players who started and those on the bench. It also provides summary performance data for players who participated in the match, such as minutes played, goals, and cards.

```APIDOC
## Get match lineups

### Description
Fetches the lineup data for a match, including players who started and those on the bench. It also provides summary performance data for players who participated in the match, such as minutes played, goals, and cards.

### Function Signature
`fb_match_lineups(match_url)`

### Parameters
#### Path Parameters
- **match_url** (string) - Required - The URL of the FBref match page.
```

--------------------------------

### Extract Match Lineups and Player Stats

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Get a dataframe of all players for a match, including starting status and performance data. Requires a match URL.

```r
# function to extract match lineups
liv_mci_2020_lineups <- fb_match_lineups(match_url = "https://fbref.com/en/matches/47880eb7/Liverpool-Manchester-City-November-10-2019-Premier-League")
dplyr::glimpse(liv_mci_2020_lineups)
```

--------------------------------

### Example: Fetching Player Possession Stats

Source: https://jaseziv.github.io/worldfootballR/reference/fb_big5_advanced_season_stats.html

Demonstrates how to call `fb_big5_advanced_season_stats` to retrieve player possession statistics for the 2021 season. This example is wrapped in a try-catch block for error handling and within an `if(FALSE)` condition to prevent accidental execution.

```R
if (FALSE) { # \dontrun{
try({
fb_big5_advanced_season_stats(season_end_year=2021,stat_type="possession",team_or_player="player")
})
} # }
```

--------------------------------

### Get League Tables by Matchday

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Extract league tables for a specified range of matchdays. Requires country name, start year, and matchday range.

```R
league_one_matchday_1_table <- tm_matchday_table(start_year="2020", matchday=1:5,
                                                 league_url="https://www.transfermarkt.com/league-one/startseite/wettbewerb/GB3")
dplyr::glimpse(league_one_matchday_1_table)
```

--------------------------------

### Get Transfermarkt Team URLs for a League Season

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Retrieve a list of URLs for all teams within a specific league and season from Transfermarkt.com. This function can use a country name and start year, or a direct league URL if the league is not in the package's data.

```R
team_urls <- tm_league_team_urls(country_name = "England", start_year = 2020)
# if it's not a league in the stored leagues data in worldfootballR_data repo:
league_one_teams <- tm_league_team_urls(start_year = 2020, league_url = "https://www.transfermarkt.com/league-one/startseite/wettbewerb/GB3")
```

--------------------------------

### Example Usage of fb_match_results

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_results.html

Demonstrates how to call the `fb_match_results` function for different scenarios, including a specific country and season, and for a lower league tier.

```R
if (FALSE) { # \dontrun{ 
try({
 df <- fb_match_results(country = c("ITA"), gender = "M", season_end_year = 2021)
 # for results from English Championship:
 df <- fb_match_results(country = "ENG", gender = "M", season_end_year = 2021, tier = "2nd")
 # for international friendlies:

})
} # }
```

--------------------------------

### Load FBref Advanced Player Match Stats for EPL

Source: https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html

Use `load_fb_advanced_match_stats` to load detailed player statistics. Specify `stat_type = "summary"` and `team_or_player = "player"` to get player-level summary data for a given league and season. This example loads data for the English Premier League (EPL) from the 2018 season onwards.

```r
## 2018 - current season for EPL
epl_summary_player_match_stats <- load_fb_advanced_match_stats(
  country = "ENG",
  gender = "M",
  tier = "1st",
  stat_type = "summary",
  team_or_player = "player"
)
dplyr::glimpse(epl_summary_player_match_stats)
```

--------------------------------

### Get Understat league match results

Source: https://jaseziv.github.io/worldfootballR/reference/understat_league_match_results.html

Call this function with the league name and the starting year of the season to retrieve match results. Available leagues include 'EPL', 'La liga', 'Bundesliga', 'Serie A', 'Ligue 1', and 'RFPL'.

```r
understat_league_match_results(league, season_start_year)
```

--------------------------------

### Load worldfootballR Library

Source: https://jaseziv.github.io/worldfootballR/index.html

Loads the worldfootballR package into the current R session, making its functions available for use. This should be run after installation.

```R
library(worldfootballR)
```

--------------------------------

### Get Transfermarkt Player Bios

Source: https://jaseziv.github.io/worldfootballR/reference/tm_player_bio.html

Retrieves a data frame of player bios from transfermarkt.com using player URLs.

```APIDOC
## tm_player_bio

### Description
Returns data frame of player bios from transfermarkt.com.

### Usage
```R
tm_player_bio(player_urls)
```

### Arguments
* `player_urls` (character or character vector) - player url(s) from transfermarkt

### Value
Returns a dataframe of player bios.

### Examples
```R
if (FALSE) { # \dontrun{
try({
player_url <- "https://www.transfermarkt.com/eden-hazard/profil/spieler/50202"
tm_player_bio(player_url)
tm_player_bio(player_urls = c("https://www.transfermarkt.com/eden-hazard/profil/spieler/50202",
                              "https://www.transfermarkt.com/sergio-ramos/profil/spieler/25557",
                              "https://www.transfermarkt.com/ivo-grbic/profil/spieler/226073"))
})
}
```
```

--------------------------------

### Get Player Goal and Assist Logs

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Use `fb_player_goal_logs()` to retrieve logs for goals, assists, or both for a specific player. Requires a player URL from FBref.

```r
jwp_url <- "https://fbref.com/en/players/3515d404/James-Ward-Prowse"
goal_log <- fb_player_goal_logs(jwp_url, goals_or_assists="both")

dplyr::glimpse(goal_log)
```

--------------------------------

### Example: Load Player Stats for English 1st Tier Men's League

Source: https://jaseziv.github.io/worldfootballR/reference/load_fb_advanced_match_stats.html

Demonstrates loading player-level advanced match statistics for the English men's 1st tier league. Ensure the function is available in your environment.

```R
# \donttest{
try({
load_fb_advanced_match_stats(
  country = "ENG",
  gender = "M",
  tier = "1st",
  stat_type = "summary",
  team_or_player = "player"
)

load_fb_advanced_match_stats(
  country = c("ITA", "ESP"),
  gender = "M",
  tier = "1st",
  season_end_year = 2023,
  stat_type = "defense",
  team_or_player = "player"
)
})
# >
#> → Data last updated 2025-08-19 10:40:31.5149250030518 UTC
#> Error in dplyr::bind_rows(res, .id = .id) :
#>   Can't combine `..1$Home_Score` <character> and `..2$Home_Score` <double>.
# }
```

--------------------------------

### Example: Fetching Possession Stats

Source: https://jaseziv.github.io/worldfootballR/reference/fb_advanced_match_stats.html

Demonstrates how to retrieve player possession statistics for a given season and country. Ensure `fb_match_urls` is called first to obtain the necessary match URLs.

```R
if (FALSE) { # \dontrun{
try({
urls <- fb_match_urls(country = "AUS", gender = "F", season_end_year = 2021, tier = "1st")

df <- fb_advanced_match_stats(match_url=urls,stat_type="possession",team_or_player="player")
})
} # }
```

--------------------------------

### Get EPL Team URLs

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Extracts team URLs for a specified league and season. Ensure the country and start year are correctly provided.

```r
epl_teams <- tm_league_team_urls(country_name = "England", start_year = 2021)
```

--------------------------------

### Get Italy Team URLs

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Retrieves all team URLs for a specified country and year. Ensure the country name and start year are correct.

```r
italy_team_urls <- tm_league_team_urls(country_name = "Italy", start_year = 2024)
```

--------------------------------

### Example: Fetching Match Summary Data

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_summary.html

Demonstrates how to fetch match summary data for a given match URL. Ensure the `fb_match_urls` function is used to obtain valid URLs.

```R
if (FALSE) { # \dontrun{
try({
match <- fb_match_urls(country = "AUS", gender = "F", season_end_year = 2021, tier = "1st")[1]
df <- fb_match_summary(match_url = match)
})
} # }
```

--------------------------------

### R Example: Fetching Match Shooting Data

Source: https://jaseziv.github.io/worldfootballR/reference/fb_match_shooting.html

Demonstrates how to use the `fb_match_shooting` function to fetch shooting data for a specific match. Includes error handling and a sample match URL.

```R
if (FALSE) { # \dontrun{
try({
match <- "https://fbref.com/en/matches/bf52349b/Fulham-Arsenal-September-12-2020-Premier-League"
df <- fb_match_shooting(match_url = match)
})
} # }
```

--------------------------------

### Get Understat League Season Shots

Source: https://jaseziv.github.io/worldfootballR/reference/understat_league_season_shots.html

Use this function to retrieve shooting locations for all matches played in a selected league season from Understat.com. Requires specifying the league and the season start year.

```R
understat_league_season_shots(league, season_start_year)
```

--------------------------------

### Retrieve Understat team metadata

Source: https://jaseziv.github.io/worldfootballR/reference/understat_team_meta.html

Use this function to get team metadata from Understat. It requires a vector of team names. The example code is wrapped in `if (FALSE)` and `try()` to prevent execution during package checks.

```R
if (FALSE) { # \dontrun{
try({
understat_team_meta(team_name = c("Liverpool", "Manchester City"))
})
} # }
```

--------------------------------

### Initialize Pull Request Branch

Source: https://jaseziv.github.io/worldfootballR/CONTRIBUTING.html

Creates a new Git branch specifically for your pull request. Replace 'brief-description-of-change' with a concise summary of your modifications.

```r
usethis::pr_init("brief-description-of-change")
```

--------------------------------

### Load FBref Match Summaries for Multiple Leagues

Source: https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html

Load match summaries for multiple leagues simultaneously by providing a vector of country codes. This example retrieves data for Italian and French top-tier leagues for the 2019 season.

```r
## just 2019, for multiple leagues at the same time
multiple_match_summary_2019 <- load_fb_match_summary(
  country = c("ITA", "FRA"),
  gender = "M",
  tier = "1st",
  season_end_year = 2019
)
dplyr::glimpse(multiple_match_summary_2019)
```

--------------------------------

### Get Player Market Values Function Signature

Source: https://jaseziv.github.io/worldfootballR/reference/get_player_market_values.html

This is the function signature for `get_player_market_values`. Use this function to retrieve player valuations by specifying the country and start year of the league season. A league URL can be provided if the country is not directly supported.

```R
get_player_market_values(country_name, start_year, league_url = NA)
```

--------------------------------

### Load FBref Match Shooting Data for Multiple Leagues

Source: https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html

Load match shooting logs for multiple countries simultaneously for a specified season. This example loads data for Italy and France for the 2019 season.

```r
multiple_match_shooting_2019 <- load_fb_match_shooting(
  country = c("ITA", "FRA"),
  gender = "M",
  tier = "1st",
  season_end_year = 2019
)
dplyr::glimpse(multiple_match_shooting_2019)
```

--------------------------------

### Get transfermarkt Team URLs

Source: https://jaseziv.github.io/worldfootballR/reference/tm_league_team_urls.html

Use this function to retrieve a character vector of all transfermarkt team URLs for a selected league. Specify the country name and the start year of the season. The `league_url` argument can be used if the country name is not available in the main function.

```R
tm_league_team_urls(country_name, start_year, league_url = NA)
```

--------------------------------

### Load FBref Match Shooting Data for EPL

Source: https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html

Load match shooting logs for a specific league, gender, and tier. This example loads data for the English Premier League (EPL) for the current season.

```r
epl_match_shooting <- load_fb_match_shooting(
  country = "ENG",
  gender = "M",
  tier = "1st"
)
dplyr::glimpse(epl_match_shooting)
```

--------------------------------

### Extract League Debutants

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Retrieve a list of players making their league or professional debut. Specify debut type ('league' or 'pro') and the year range for debut data.

```R
laliga_debutants <- tm_league_debutants(country_name = "Spain", debut_type = "league", debut_start_year = 2021, debut_end_year = 2021)
dplyr::glimpse(laliga_debutants)
```

```R
league_one_PRO_debutants <- tm_league_debutants(country_name = "", league_url = "https://www.transfermarkt.com/league-one/startseite/wettbewerb/GB3", debut_type = "pro", debut_start_year = 2021, debut_end_year = 2021)
dplyr::glimpse(league_one_PRO_debutants)
```

--------------------------------

### Get Team Goal Logs

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Retrieve goal logs for a team using `fb_team_goal_logs`. Specify whether to get logs for goals 'for', 'against', or 'both'.

```R
man_city_url <- "https://fbref.com/en/squads/b8fd03ef/Manchester-City-Stats"
goal_log <- function(team_urls = man_city_url, for_or_against="both")

dplyr::glimpse(goal_log)
```

--------------------------------

### Create GitHub Fork and Clone

Source: https://jaseziv.github.io/worldfootballR/CONTRIBUTING.html

Use this function to fork the package repository from GitHub and clone it to your local machine. This is recommended for users new to contributing via GitHub.

```r
usethis::create_from_github("Jaseziv/worldfootballR", fork = TRUE)
```

--------------------------------

### Get Player URLs for a Team

Source: https://jaseziv.github.io/worldfootballR/reference/tm_team_player_urls.html

Use this function to get a character vector of all transfermarkt player URLs for a selected team. Requires the team's URL as input.

```R
tm_team_player_urls(team_url)
```

--------------------------------

### Load FBref Match Summaries for EPL

Source: https://jaseziv.github.io/worldfootballR/articles/load-scraped-data.html

Use `load_fb_match_summary` to load match summaries for a specific league and season range. This example loads data for the English Premier League (EPL) from the 2018 season onwards.

```r
## 2018 - current season for EPL
epl_match_summary <- load_fb_match_summary(
  country = "ENG",
  gender = "M",
  tier = "1st"
)
dplyr::glimpse(epl_match_summary)
```

--------------------------------

### Get Player Injury History

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Use tm_player_injury_history() to retrieve injury data for one or more players. For multiple players, you can first use tm_team_player_urls() to get a list of player URLs.

```R
#----- for a single player: -----
hazard_injuries <- tm_player_injury_history(player_urls = "https://www.transfermarkt.com/eden-hazard/profil/spieler/50202")
dplyr::glimpse(hazard_injuries)

#----- for multiple players: -----
# # can make use of a tm helper function:
# burnley_player_urls <- tm_team_player_urls(team_url = "https://www.transfermarkt.com/fc-burnley/startseite/verein/1132/saison_id/2021")
# # then pass all those URLs to the tm_player_injury_history
# burnley_player_injuries <- tm_player_injury_history(player_urls = burnley_player_urls)
```

--------------------------------

### tm_matchday_table Function

Source: https://jaseziv.github.io/worldfootballR/reference/tm_matchday_table.html

Fetches the league table for each chosen matchday from Transfermarkt. It requires the country name, the starting year of the season, and the matchday number. An optional `league_url` can be provided if the country name is not sufficient.

```APIDOC
## tm_matchday_table

### Description
Returns the league table for each chosen matchday from transfermarkt.

### Usage
```R
tm_matchday_table(country_name, start_year, matchday, league_url = NA)
```

### Arguments

*   **country_name** (string) - Required - The country of the league's players.
*   **start_year** (string) - Required - The start year of the season (e.g., "2020" for the 20/21 season).
*   **matchday** (numeric or vector of numeric) - Required - The matchweek number. Can be a vector of matchdays.
*   **league_url** (string) - Optional - League URL from transfermarkt.com. To be used when `country_name` is not available in the main function.

### Value
Returns a dataframe of the table for a selected league and matchday.

### Examples
```R
if (FALSE) { # \dontrun{
try({
  tm_matchday_table(country_name="England", start_year="2020", matchday=1)
  tm_matchday_table(country_name="England", start_year="2020", matchday=c(1:5))
})
} # }
```
```

--------------------------------

### Get fbref Team URLs

Source: https://jaseziv.github.io/worldfootballR/reference/fb_teams_urls.html

Use this function to get all team URLs for a given league. It requires the league URL and allows setting a time pause between page loads.

```R
fb_teams_urls(league_url, time_pause = 3)
```

```R
fb_teams_urls("https://fbref.com/en/comps/9/Premier-League-Stats")
```

--------------------------------

### Load FBref Match Summary Data (R)

Source: https://jaseziv.github.io/worldfootballR/reference/load_fb_match_summary.html

Loads match summary data for a specified country, gender, and league tier. Use this function to retrieve historical match data from FBref. Ensure parameters are correct as data loading may fail.

```r
load_fb_match_summary(
  country = "ENG",
  gender = "M",
  tier = "1st"
)
```

```r
load_fb_match_summary(
  country = c("ITA", "ESP"),
  gender = "M",
  tier = "1st",
  season_end_year = 2019
)
```

--------------------------------

### Get Player URLs for a Team

Source: https://jaseziv.github.io/worldfootballR/reference/fb_player_urls.html

Use this function to get all player URLs for a given team. Specify the team's URL and an optional pause time between page loads.

```R
fb_player_urls(team_url, time_pause = 3)
```

```R
try({
fb_player_urls("https://fbref.com/en/squads/fd962109/Fulham-Stats")
})
```

--------------------------------

### Get team player wages

Source: https://jaseziv.github.io/worldfootballR/reference/fb_squad_wages.html

Fetches player wages for a given team URL. Use this to get estimated player wages from FBref. Ensure the team URL is valid.

```R
if (FALSE) { # \dontrun{
try({
# for single teams:
man_city_url <- "https://fbref.com/en/squads/b8fd03ef/Manchester-City-Stats"
fb_squad_wages(team_urls = man_city_url)
})
} # }
```

--------------------------------

### Get Understat available teams

Source: https://jaseziv.github.io/worldfootballR/reference/understat_available_teams.html

Call the function with a character vector of desired leagues to retrieve team names. Use this to get a list of teams for specific leagues available on Understat.

```R
understat_available_teams(leagues = c('EPL', 'La liga'))
```

--------------------------------

### Extract Transfermarkt League Table by Matchday

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Retrieve the league table from Transfermarkt.com for a specified country, season, and matchday(s). Alternatively, a league URL can be provided for leagues not included in the package's data.

```R
#----- to get the EPL table after matchday 1 of the 20/21 season: -----
epl_matchday_1_table <- tm_matchday_table(country_name="England", start_year="2020", matchday=1)
dplyr::glimpse(epl_matchday_1_table)
```

--------------------------------

### Get Squad Player Stats for Multiple Teams

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Use `tm_squad_stats()` with a vector of team URLs to get squad statistics for multiple teams. First, obtain team URLs using `tm_league_team_urls()`.

```r
#----- or for multiple teams: -----
# team_urls <- tm_league_team_urls(country_name = "England", start_year = 2020)
# epl_team_players_2020 <- tm_squad_stats(team_url = team_urls)
```

--------------------------------

### Get FBref Team URLs

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Obtain a list of URLs for all teams within a specific league season on FBref.com. This function requires a league URL as input.

```R
fb_teams_urls("https://fbref.com/en/comps/9/Premier-League-Stats")
```

--------------------------------

### Batch Extraction with fb_league_stats

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Demonstrates how to use `fb_league_stats` to extract data for multiple countries, genders, seasons, and tiers simultaneously. Note that `stat_type` and `team_or_player` should only have one value specified.

```r
# fb_league_stats(
#   country = c("ENG", "ESP")
#   gender = c("M", "F")
#   season_end_year = 2020:2021,
#   tier = c("1st", "2nd"),
#   non_dom_league_url = NA,
#   stat_type = "shooting",
#   team_or_player = "player"
# )
```

--------------------------------

### Get League Risk of Suspension by Country

Source: https://jaseziv.github.io/worldfootballR/reference/tm_get_risk_of_suspension.html

Call the function with a country name to get suspension risk data for leagues within that country. Ensure the `try` block is used for error handling.

```R
tm_get_risk_of_suspension(country_name = "England")
```

--------------------------------

### Load Functions

Source: https://jaseziv.github.io/worldfootballR/reference/index.html

Functions for loading pre-saved football data from various sources.

```APIDOC
## load_fb_advanced_match_stats()

### Description
Load pre-saved FBref match advanced stats

## load_fb_big5_advanced_season_stats()

### Description
Load Big 5 Euro League Season Stats

## load_fb_match_shooting()

### Description
Load pre-saved FBref match shooting event data

## load_fb_match_summary()

### Description
Load pre-saved FBref match summary data

## load_match_comp_results()

### Description
Load match competition results

## load_match_results()

### Description
Load match results

## load_understat_league_shots()

### Description
Load Understat league shot locations
```

--------------------------------

### Get fbref Team's Player Season Statistics

Source: https://jaseziv.github.io/worldfootballR/reference/fb_team_player_stats.html

Retrieves a team's player season stats for a selected team(s) and stat type. Use this function to get detailed player performance data.

```R
fb_team_player_stats(team_urls, stat_type, time_pause = 3)
```

```R
if (FALSE) { # \dontrun{ 
try({
fb_team_player_stats("https://fbref.com/en/squads/d6a369a2/Fleetwood-Town-Stats",
                       stat_type = 'standard')

league_url <- fb_league_urls(country = "ENG", gender = "M",
                                             season_end_year = 2022, tier = "3rd")
team_urls <- fb_teams_urls(league_url)
multiple_playing_time <- fb_team_player_stats(team_urls,
                         stat_type = "playing_time")
})
} # }
```

--------------------------------

### Get Transfermarkt Staff URLs for Teams and Roles

Source: https://jaseziv.github.io/worldfootballR/articles/extract-transfermarkt-data.html

Fetch staff URLs for teams within a league season, specifying the staff role (e.g., 'Manager', 'Assistant Manager', 'Goalkeeping Coach'). This requires pre-obtained team URLs.

```R
# get a list of team URLs for the EPL 2021/22 season
epl_teams <- tm_league_team_urls(country_name = "England", start_year = 2021)
# get all EPL managers for the 2021/22 season
epl_managers <- tm_team_staff_urls(team_urls = epl_teams, staff_role = "Manager")

# get all EPL goal keeping coaches for the 2021/22 season
epl_gk_coaches <- tm_team_staff_urls(team_urls = epl_teams, staff_role = "Goalkeeping Coach")
```

--------------------------------

### tm_league_debutants

Source: https://jaseziv.github.io/worldfootballR/reference/tm_league_debutants.html

Returns a data frame of debutants for a selected league.

```APIDOC
## tm_league_debutants

### Description
Returns a data frame of debutants for a selected league.

### Usage
```R
tm_league_debutants(
  country_name,
  league_url = NA,
  debut_type,
  debut_start_year,
  debut_end_year
)
```

### Arguments 

* **country_name** (character) - the country of the league's players 
* **league_url** (character, optional) - league url from transfermarkt.com. To be used when country_name not available in main function 
* **debut_type** (character) - whether you want 'league' debut or 'pro' debut 
* **debut_start_year** (numeric) - the season start year of the beginning of the period you want results for 
* **debut_end_year** (numeric) - the season start year of the end of the period you want results for

### Value
returns a dataframe of players who debuted in the selected league
```

--------------------------------

### Get Player Shots

Source: https://jaseziv.github.io/worldfootballR/reference/understat_player_shots.html

Fetches shooting locations for a given player URL from Understat.com.

```APIDOC
## understat_player_shots

### Description
Returns shooting locations for a selected player for all matches played from Understat.com.

### Usage
```R
understat_player_shots(player_url)
```

### Arguments
* `player_url` (string) - The URL of a selected player.

### Value
Returns a dataframe of shooting locations for a selected player.
```

--------------------------------

### Get FBref League URLs

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Retrieve URLs for leagues on FBref.com for a specified country, gender, and season. The 'tier' argument can be used to filter by league level (e.g., '1st', '2nd').

```R
fb_league_urls(country = "ENG", gender = "M", season_end_year = 2021, tier = '2nd')
```

--------------------------------

### Get Understat Match Stats

Source: https://jaseziv.github.io/worldfootballR/reference/understat_match_stats.html

Fetches the statistics table data for a specific match from Understat.com.

```APIDOC
## understat_match_stats

### Description
Returns the Stats values for a selected match from Understat.com.

### Usage
```R
understat_match_stats(match_url)
```

### Arguments
#### Path Parameters
* **match_url** (character) - Required - A character string with the URL of the match played.

### Value
Returns a `data.frame` with data from the stats table for the match.
```

--------------------------------

### Get FBref Player URLs for a Team

Source: https://jaseziv.github.io/worldfootballR/articles/extract-fbref-data.html

Generate a list of player URLs for a given team's squad page on FBref.com. The output can be used as input for player statistics functions.

```R
fb_player_urls("https://fbref.com/en/squads/fd962109/Fulham-Stats")
```

--------------------------------

### Get League Injuries

Source: https://jaseziv.github.io/worldfootballR/reference/tm_league_injuries.html

Retrieves a data frame of all currently injured players for a selected league.

```APIDOC
## tm_league_injuries

### Description
Returns a data frame of all currently injured players for a selected league.

### Usage
```R
tm_league_injuries(country_name, league_url = NA)
```

### Arguments

*   **country_name** (character) - The country of the league's players.
*   **league_url** (character, optional) - League URL from transfermarkt.com. To be used when country_name is not available in the main function.

### Value
Returns a dataframe of injured players in the selected league.
```
Tokens:
Raw