From c2f6939c6a597f0bce8fe854d008c277f49a560a Mon Sep 17 00:00:00 2001 From: rossdrucker Date: Thu, 15 Feb 2024 09:43:40 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20sportsda?= =?UTF-8?q?taverse/sportyR@5500cc6a094aae9102a17ef5ed437b055a7e264b=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pkgdown.yml | 2 +- reference/curling_features_set_colors.html | 10 +++++----- search.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/pkgdown.yml b/pkgdown.yml index 9104faf..2d6a353 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -6,7 +6,7 @@ articles: customize-plot: customize-plot.html plotting-tracking-data: plotting-tracking-data.html sportyR: sportyR.html -last_built: 2024-02-15T09:23Z +last_built: 2024-02-15T09:41Z urls: reference: https://sportyR.sportsdataverse.org/reference article: https://sportyR.sportsdataverse.org/articles diff --git a/reference/curling_features_set_colors.html b/reference/curling_features_set_colors.html index c98491c..0af11d1 100644 --- a/reference/curling_features_set_colors.html +++ b/reference/curling_features_set_colors.html @@ -158,6 +158,11 @@

ArgumentsArguments

Value

diff --git a/search.json b/search.json index c9cc070..185bb40 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://sportyR.sportsdataverse.org/CODE-OF-CONDUCT.html","id":null,"dir":"","previous_headings":"","what":"Contributor Code of Conduct","title":"Contributor Code of Conduct","text":"contributors maintainers project, pledge respect people contribute reporting issues, posting feature requests, updating documentation, submitting pull requests patches, activities. committed making participation project harassment-free experience everyone, regardless level experience, gender, gender identity expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion. Examples unacceptable behavior participants include use sexual language imagery, derogatory comments personal attacks, trolling, public private harassment, insults, unprofessional conduct. Project maintainers right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct. Project maintainers follow Code Conduct may removed project team. Instances abusive, harassing, otherwise unacceptable behavior may reported opening issue, contacting emailing project lead (ross..drucker@gmail.com). Code Conduct adapted Contributor Covenant, version 1.0.0, available https://www.contributor-covenant.org/version/1/0/0/code--conduct.html","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to sportyR","title":"Contributing to sportyR","text":"First , thanks considering contributing sportyR! package, just like open source projects, can’t improve without contributions feedback users. sportyR labor love, one paid work . Please keep mind throughout contributions, responses bug fixes may take bit time work .","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"play-by-the-rules---code-of-conduct","dir":"","previous_headings":"","what":"Play by the Rules - Code of Conduct","title":"Contributing to sportyR","text":"Please note project released Contributor Code Conduct. participating project, ’re agreeing abide terms. sportyR’s League Office (see ) reserves right limit /exclude contributions violate Code Conduct appropriate.","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"getting-in-the-game---making-contributions","dir":"","previous_headings":"","what":"Getting In The Game - Making Contributions","title":"Contributing to sportyR","text":"’s many ways can contribute sportyR. want complete explanation can contribute (open source project, just one), check guide.","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"be-a-fan---love-the-package","dir":"","previous_headings":"Getting In The Game - Making Contributions","what":"Be A Fan - Love the Package","title":"Contributing to sportyR","text":"Think sportyR awesome? Want share awesome plots gifs made ? Let others discover telling person, tagging project Twitter, writing blog post experience ! ’re using sportyR academic context, please best cite package well.","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"scouting-reports---bugs-and-feature-suggestions","dir":"","previous_headings":"Getting In The Game - Making Contributions","what":"Scouting Reports - Bugs and Feature Suggestions","title":"Contributing to sportyR","text":"Like good sports organization, sportyR best scout solve problems become problems. Given tough test, problems sure arise. can overcome next match, however, making use good scouting (bug) reports. Please create Issue find something needs fixed. ’s good general guide follow creating one: Please double check README Issues pages sure problem hasn’t already solved. isn’t meant stop reporting problem, rather sure ’s new one can properly addressed. Title issue clear description ’re looking . Titling Issue “weird…” doesn’t give good idea ’re titling Issue “NCAA Football hashmarks place.” Even better can prefix/tag Issue bug feature-request Spend time creating detailed explanation, reproducible example, problem ’re . Without able understand issue, ’s even harder find ’s causing occur. best make sure code well-formatted easy others read: Make sure name variables something informative Use comments indicate believe problem code occurring include necessary code recreate problem Issue report can solved correctly","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"the-league-office-directory---contributor-status","dir":"","previous_headings":"Getting In The Game - Making Contributions","what":"The League Office Directory - Contributor Status","title":"Contributing to sportyR","text":"Want join sportyR’s team help shape package? Great! ’re always recruiting! ’s can join: League Office — contributing regularly, providing substantial upgrades package’s overall structure function, helping maintain package across board, ’ll considered membership sportyR’s League Office. order join League Office, must invited current member get approved majority members League Office become League Officer, list README, also list DESCRIPTION file role \"aut\" General Managers — Writing code extends sportyR’s sport-plotting reach developing new sports earn spot General Manager. Please list (alphabetical--sport order) README sport ’ve added. Note contributing new sport, ’ll considered General Manager sport. may asked assist sport-specific issues League Office unable provide clear answer Coaching Staffs — Patching bug already-existing sport means ’re eligible sport’s coaching staff. ’ve got eye game, ’s much appreciated! Coaches can list README well, similar General Managers listed Scout Team — fixing typo, making slight modification something already exists sportyR, regularly reporting issues package encounter (even helping others solve ), can join Scout Team. Thanks front lines package’s operation! Feel free list README Scout Team brief description role (“Typo Fixer” “Question Answerer” work great, creative ’d like)","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"becoming-a-coachgeneral-manager---pull-request-process","dir":"","previous_headings":"","what":"Becoming a Coach/General Manager - Pull Request Process","title":"Contributing to sportyR","text":"become Cocah General Manager, submit Pull Request (PR) GitHub using process: Create branch git make changes wish see implemented Push branch GitHub open PR. PR titled way ’s obvious ’s overarching goal Discuss PR much detail possible. Provide links sources, clearly explain PR necessary can used. deviations conventions rest package clearly explained, deviation necessary Continue iterating request League Office determines addition good fit sportyR request checked following points: Motivation — Clearly concisely explain motivated PR. addresses particular issue, sure link Related Changes — submit PR, make sure PR addresses one issue. want fix multiple issues, please address separate PRs ’s clear change made PR. Please also sure PR doesn’t introduce new bugs break existing code Code Style File Naming — Please follow tidyverse styleguide, deviation explicit calls return() order return ’s needed function. Maintaining consistent styling facilitates easier current maintenance future development. Additionally, please keep consistent naming new files, especially adding new sport. Files contain new league named features-{sport}.R, new sport entirely, sure add corresponding geom-{new sport }.R file well. Dimensions maintained data-raw/surface-dimensions.json file, data-raw/internal_datasets.R sourced incorporate new changes. Please parameterize surface best abilities, ask questions! Documentation — introducing new code, please make sure document appropriately. Documentation comes two main forms: roxygen2 documentation functions write, comments throughout code explain code trying achieve. types documentation important! sure run devtools::document() sure documentation files properly created submitting, sure check spelling grammar. quick note internal/helper function documentation: please make sure omit files package build using @keywords internal roxygen2 documentation. reduces overall size package submitted CRAN, allows maximum package size 5MB Testing — sportyR relies upon extensive testing ensure package runs smoothly. currently 100% code coverage, PR ensure remains case. test coverage, sure covr package installed run following commands: show new code lacks sufficient coverage, please sure add tests tests/ repository make sure ’re covered! help creating tests, please reach League Office Although seems like lot work big hassle, League Office doesn’t expect perfection hand help needed.","code":"cov <- covr::package_coverage() covr::zero_coverage(cov)"},{"path":"https://sportyR.sportsdataverse.org/articles/animating-tracking-data.html","id":"the-data","dir":"Articles","previous_headings":"","what":"The Data","title":"Animating Tracking Data","text":"example, ’ll use play Week 15 2018 NFL season Chicago Bears Green Bay Packers. Data made available Big Data Bowl 2021 Kaggle competition. keep things easy, let’s specify colors team’s dots resulting GIF. ’ll make Bears orange Packers yellow. football also need dot seen; let’s make brown. First, let’s draw NFL field via geom_football(\"nfl\"). ’ll adjust origin lower left corner field, per notes coordinate system Kaggle page describing data. Image NFL field rendered sportyR Looks good! Now, let’s animate using gganimate. Gif tracking data Easy peasy. noted plotting-tracking-data vignette, works long geospatial data provided contains way identify order frames resulting GIF.","code":"# Load the play data example_nfl_play <- data.table::fread( glue::glue( \"https://raw.githubusercontent.com/sportsdataverse/sportyR/\", \"main/data-raw/example-pbp-data.csv\" ) ) # Convert to data frame example_nfl_play <- as.data.frame(example_nfl_play) # Prep data for plotting example_nfl_play[example_nfl_play[\"team\"] == \"home\", \"color\"] <- \"#c83803\" example_nfl_play[example_nfl_play[\"team\"] == \"away\", \"color\"] <- \"#ffb612\" example_nfl_play[example_nfl_play[\"team\"] == \"football\", \"color\"] <- \"#624a2e\" # Create the field nfl_field <- geom_football(\"nfl\", x_trans = 60, y_trans = 26.6667) # Display the field nfl_field # Add the points on the field play_anim <- nfl_field + geom_point( data = example_nfl_play, aes(x, y), color = example_nfl_play$color ) + transition_time(example_nfl_play$frameId) # Show the animation play_anim"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Plotting Tracking Data","text":"sportyR seeks make plotting geospatial tracking data straight-forward possible, allowing focus analysis visuals. ’ll demonstrate examples use package display “static” data, data shows snapshot time","code":""},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"the-data","dir":"Articles","previous_headings":"","what":"The Data","title":"Plotting Tracking Data","text":"example, ’ll using data provided Big Data Cup, publicly available. Specifically, data ’ll use demonstrate plot comes data provided Big Data Cup - 2021. Start reading data CSV file provided: Let’s explore dataset bit see () changes helpful ’d helpful change names columns easier work , ’ll change X Coordinate Y Coordinate x y, X Coordinate 2 Y Coordinate 2 x2 y2. ’ll use first game data , Minnesota Whitecaps Boston Pride. keep things easy ’ll focus first single-point data: shots. keep shots team side ice, need adjust coordinates shot. ’ve got keep shooter’s perspective towards net constant well, following appropriate transformation. positions data correctly, let’s move plotting","code":"# Read data from the Big Data Cup bdc_data <- data.table::fread( glue::glue( \"https://raw.githubusercontent.com/bigdatacup/Big-Data-Cup-2021\", \"/main/hackathon_nwhl.csv\" ) ) # Convert to data frame bdc_data <- as.data.frame(bdc_data) names(bdc_data) #> [1] \"game_date\" \"Home Team\" \"Away Team\" #> [4] \"Period\" \"Clock\" \"Home Team Skaters\" #> [7] \"Away Team Skaters\" \"Home Team Goals\" \"Away Team Goals\" #> [10] \"Team\" \"Player\" \"Event\" #> [13] \"X Coordinate\" \"Y Coordinate\" \"Detail 1\" #> [16] \"Detail 2\" \"Detail 3\" \"Detail 4\" #> [19] \"Player 2\" \"X Coordinate 2\" \"Y Coordinate 2\" # Change names of X Coordinate and Y Coordinate to x and y respectively names(bdc_data)[13:14] <- c(\"x\", \"y\") names(bdc_data)[20:21] <- c(\"x2\", \"y2\") # Preview what the data looks like knitr::kable(head(bdc_data)) # Subset to only be shots from the game on 2021-01-23 between the Minnesota # White Caps and Boston Pride bdc_shots <- bdc_data[(bdc_data$Event == \"Shot\") & (bdc_data$`Home Team` == \"Minnesota Whitecaps\") & (bdc_data$game_date == \"2021-01-23\"), ] # Separate shots by team whitecaps_shots <- bdc_shots[bdc_shots$Team == \"Minnesota Whitecaps\", ] pride_shots <- bdc_shots[bdc_shots$Team == \"Boston Pride\", ] # Correct the shot location whitecaps_shots[\"x\"] <- 200 - whitecaps_shots[\"x\"] whitecaps_shots[\"y\"] <- 85 - whitecaps_shots[\"y\"]"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"drawing-the-plot","dir":"Articles","previous_headings":"","what":"Drawing the Plot","title":"Plotting Tracking Data","text":"Since data pertains Premier Hockey Federation (PHF), ’ll start plotting drawing PHF-sized rink. ’ll use x_trans y_trans align data plot coordinates. encourage experiment data see works practice Now ’s left add data points plot! ggplot2 designed, straightforward.","code":"# Draw the rink phf_rink <- geom_hockey(\"phf\", x_trans = 100, y_trans = 42.5) # Display the rink here phf_rink"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"adding-the-data","dir":"Articles","previous_headings":"","what":"Adding the Data","title":"Plotting Tracking Data","text":"","code":"# Add the shots to the plot phf_rink + geom_point(data = whitecaps_shots, aes(x, y), color = \"#2251b8\") + geom_point(data = pride_shots, aes(x, y), color = \"#fec52e\")"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"two-coordinate-data","dir":"Articles","previous_headings":"","what":"Two-Coordinate Data","title":"Plotting Tracking Data","text":"Pretend instead want look team’s passes executed game. also easy . Let’s take dataset , bdc_data, time subset look Boston’s passes game. ’ve already got rink plot , let’s just subset passing data, add plot: ! works geospatial data, sport (supported sportyR), league (supported sportyR). Give try, please reach ideas improvements!","code":"# Subset the data to be Boston's passes boston_passes <- bdc_data[(bdc_data$Event == \"Play\") & (bdc_data$Team == \"Boston Pride\") & (bdc_data$game_date == \"2021-01-23\"), ] # Plot passes with geom_segment() phf_rink + geom_segment( data = boston_passes, aes( x = x, y = y, xend = x2, yend = y2 ), lineend = \"round\", linejoin = \"round\", color = \"#ffcb05\" )"},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"installing-r-rstudio-and-sportyr","dir":"Articles","previous_headings":"","what":"Installing R, RStudio, and sportyR","title":"Getting Started","text":"(section courtesy Saiem Gilani. Give follow!) Head https://cran.r-project.org Select appropriate link operating system (Windows, Mac OS X, Linux) Windows - Select base download recent version Mac OS X - Select Latest Release, check make sure OS correct version. Look Binaries Legacy OS X Systems older release Linux - Select appropriate distro follow installation instructions Head RStudio.com Follow associated download installation instructions RStudio. Start peering RStudio IDE Cheatsheet. IDE integrated development environment. Windows users: recommend install Rtools. R package! “collection resources building packages R Microsoft Windows, building R ”. Go https://cran.r-project.org/bin/windows/Rtools/ follow directions installation. sportyR live CRAN, recent release can installed running: ’re development version package, try : library installed, sure load working environment.","code":"# Install released version from CRAN install.packages(\"sportyR\") # Install development version from GitHub devtools::install_github(\"sportsdataverse/sportyR\") # Required to use package library(sportyR)"},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"understanding-and-exploring-the-package","dir":"Articles","previous_headings":"","what":"Understanding and Exploring the Package","title":"Getting Started","text":"package really extension ggplot2, aim focus specifically sports playing surface. begs question: sports can plot using sportyR? ’re luck: kinds questions natively answered ’ve called cani_{question}() family functions. ’re designed answer questions like Can plot soccer pitch? Can plot PHF ice rink? ’s exact syntax can follow package answer questions. ’s example: ’ll highlight fact case-insensitive searches. Ask away heart’s content! ’s one cani_{question}() function ’ll highlight bit, first let’s start acting answers kinds questions.","code":"# Find out if you can plot a soccer pitch cani_plot_sport(\"soccer\") #> geom_soccer() can be used to plot for the following leagues: EPL, FIFA, MLS, NCAA, NWSL # See if a league comes pre-packaged with sportyR cani_plot_league(\"PHF\") #> A plot for PHF can be created via the geom_hockey() function"},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"the-geom_sport-functions","dir":"Articles","previous_headings":"","what":"The geom_{sport}() Functions","title":"Getting Started","text":"Now can ask questions package get answers, let’s start using information make plots. Say example ’re interested drawing regulation NBA basketball court. sportyR seeks make easy possible: Easy get started. ’s quick overview arguments (included geom_{sport}() functions): league: required parameter, custom viable value sport. quick note, using custom option require specify parameters surface ’re looking create. case-insensitive display_range: automatically “zooms” area plot ’re interested . Valid ranges vary sport, can found calling ?geom_{sport} reading display ranges x_trans y_trans: default, origin coordinate system always lies center plot. example, (0, 0) basketball court lies along division line line connects center basket. want shift origin (therefore entire plot), use x_trans y_trans {surface_type}_updates: list updates parameters define surface. ’ll demo use change hockey rink different vignette, ’ll call color_updates: list contains updates features’ colors plot. named feature , using snake_case specify names. get list color names can change, try running cani_color_league_features() desired league rotation: angle (degrees) ’d like rotate plot , +counterclockwise xlims ylims: limits ’d like put plot x y direction. overwrite anything set display_range parameter {surface}_units: data units different rule book league specifies units (e.g. ’ve got NHL data inches, rule book describes rink feet), change parameter match units ’ve got data . ’re welcome change units data well, provided convenience","code":"# Draw a regulation NBA basketball court geom_basketball(\"nba\")"},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"author","dir":"Articles","previous_headings":"","what":"Author","title":"Getting Started","text":"Ross Drucker","code":""},{"path":"https://sportyR.sportsdataverse.org/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Ross Drucker. Author, maintainer.","code":""},{"path":"https://sportyR.sportsdataverse.org/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Drucker R (2024). sportyR: Plot Scaled 'ggplot' Representations Sports Playing Surfaces. R package version 2.2.2, https://github.com/sportsdataverse/sportyR, https://sportyr.sportsdataverse.org/.","code":"@Manual{, title = {sportyR: Plot Scaled 'ggplot' Representations of Sports Playing Surfaces}, author = {Ross Drucker}, year = {2024}, note = {R package version 2.2.2, https://github.com/sportsdataverse/sportyR}, url = {https://sportyr.sportsdataverse.org/}, }"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"sportyr-","dir":"","previous_headings":"","what":"Plot Scaled ggplot Representations of Sports Playing Surfaces","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"field sports analytics evolve, ’s growing need methods track visualize players throughout game. package aims make easy regardless sport needed plotted. repository contains code necessary draw scale versions playing surfaces visualize play--play data baseball, basketball, curling, football, hockey, soccer, tennis R. Python version package, click .","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"recent release sportyR available CRAN, can installed directly via: development version sportyR can installed GitHub : library installed, sure load working environment.","code":"# Install released version from CRAN install.packages(\"sportyR\") # Install development version from GitHub devtools::install_github(\"sportsdataverse/sportyR\") # Required to use package library(sportyR)"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"plotting-functions","dir":"","previous_headings":"","what":"Plotting Functions","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"plotting functions library named geom_{sport}(), take following arguments: league: league code sport. functions, default value. supplied league case-insensitive. Future iterations package may allow full league name supplied desired (e.g. league = 'National Basketball Associaton' instead league = 'NBA'), feature currently available. display_range: automatically “zooms” area plot ’re interested . Valid ranges vary sport, can found calling ?geom_{sport} reading display ranges x_trans y_trans: default, origin coordinate system always lies center plot. example, (0, 0) basketball court lies along division line line connects center basket. want shift origin (therefore entire plot), use x_trans y_trans {surface_type}_updates: list updates parameters define surface. ’ll demo use change hockey rink different vignette, ’ll call color_updates: list contains updates features’ colors plot. named feature , using snake_case specify names. get list color names can change, try running cani_color_league_features() desired league rotation: angle (degrees) ’d like rotate plot , +counterclockwise xlims ylims: limits ’d like put plot x y direction. overwrite anything set display_range parameter {surface}_units: data units different rule book league specifies units (e.g. ’ve got NHL data inches, rule book describes rink feet), change parameter match units ’ve got data . ’re welcome change units data well, provided convenience","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"tv-view","dir":"","previous_headings":"TV View and Display Ranges","what":"TV View","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"geom_{sport}() functions, default, draw surface can considered “TV view”, way surface typically displayed television broadcast. typically means action moves left right across screen (basketball game baskets left right end court). mentioned , possible change orientation rotation parameter geom_{sport}() function. exceptions : geom_baseball() displayed high-home view default, baseball coordinates typically +y axis extending back tip home plate towards center field geom_tennis() displayed court diagrammed perspective chair umpire","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"display-ranges","dir":"","previous_headings":"TV View and Display Ranges","what":"Display Ranges","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Related idea custom displays plot concept display_range parameter geom_{sport}() function. unique sport, globally supported across package. parameter allows specification designated region surface display. example, ’re trying limit analysis NFL data inside red zone, may want something similar following: Another use case make data ’re viewing easier see. Say wanted look curling data, cared stone positions house (path stones got ). might :","code":"# Display only the red zone of the football field geom_football(\"nfl\", display_range = \"red zone\") # Display only the house on a curling sheet geom_curling(\"wcf\", display_range = \"house\")"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"plot-units","dir":"","previous_headings":"","what":"Plot Units","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"plot function standardized unit measure plot created, standardized primary units specified respective rule books. follows (explanation parentheses): However, since data supplied may come various units measure, plots able generated data’s units. done via unit argument geom_{sport}(). features look visually identical, underlying coordinate grid change. Additionally, convert_units() function can called data frame convert data’s arguments plot’s. example, soccer data given yards, desirable plotted meters, calling convert_units(tracking_data, 'yd', 'm', conversion_columns = c('x', 'y')) convert x y coordinates yards meters. mentioned , geom_{sport}() family functions allow rotations surfaces via rotation argument. make easy, sportyR also allows rotation data frames’ coordinates long contain x y column via rotate_coords() function. Reflection also possible reflect().","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"surface-examples","dir":"","previous_headings":"","what":"Surface Examples","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"playing surfaces standard size, can rendered via call proper geom_{sport}() function like : ’s also possible plot partial surfaces rotated surfaces:","code":"# Draw a basic MLB infield plot geom_baseball(\"mlb\", display_range = \"infield\") # Create a 100m by 75m FIFA pitch geom_soccer( \"fifa\", pitch_updates = list( pitch_length = 100, pitch_width = 75 ) ) # Draw half of a rotated NBA court geom_basketball(\"nba\", display_range = \"offense\", rotation = 270)"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"package released GPL 3.0 License.","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"league-office","dir":"","previous_headings":"Contributions","what":"League Office","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"package maintainers functional engineers Ross Drucker - sportyR Commissioner","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"general-managers","dir":"","previous_headings":"Contributions","what":"General Managers","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Contribute adding new sport become general manager. Current general managers (sports) : Ross Drucker - Baseball Ross Drucker - Basketball Ross Drucker - Curling Ross Drucker - Football Ross Drucker - Hockey Ross Drucker - Soccer Ross Drucker - Tennis Ross Drucker - Volleyball","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"coaching-staffs","dir":"","previous_headings":"Contributions","what":"Coaching Staffs","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Notice something sport already exists, isn’t quite right? Join sport’s coaching staff!","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"scout-team","dir":"","previous_headings":"Contributions","what":"Scout Team","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"regularly reporting issues, making slight modifications, fixing typos, just helping others navigate issues, ’re able join Scout Team!","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"acknowledgements","dir":"","previous_headings":"Contributions","what":"Acknowledgements","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Much underling code structure sportyR, beginning v2.0.0, influenced Bucketless’s work hockey_rink package Python.","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"sportyrtist","dir":"","previous_headings":"Contributions","what":"sportyRtist","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"sportyR logo created Lindsey Kelso. Check Instagram online shop!","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":null,"dir":"Reference","previous_headings":"","what":"Add a surface's feature to a ggplot2 instance — add_feature","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"Add surface's feature ggplot2 instance","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"","code":"add_feature( g, x_anchor, y_anchor, feature_df, feature_color, feature_outline_color = \"#ffffff00\", reflect_x = FALSE, reflect_y = FALSE, x_trans = 0, y_trans = 0, rotation = 0, group = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"g ggplot2 instance onto feature added x_anchor anchor point along x axis feature y_anchor anchor point along y axis feature feature_df data frame containing points add feature feature_color hexadecimal string color feature added plot feature_outline_color hexadecimal string color outline feature added plot. default value \"#ffffff00\", white 0% alpha value. results outline added, usually desirable, may overwritten prevent \"seams\" appearing resulting plot reflect_x Whether reflect feature x axis reflect_y Whether reflect feature y axis group grouping pass along ggplot2::aes(). used speed NFL NCAA Football plotting functions","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"ggplot2 instance feature added ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":null,"dir":"Reference","previous_headings":"","what":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"One bases diamond, really base field. squares rotated 45 degrees","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"","code":"baseball_base( base_side_length = 0, adjust_x_left = FALSE, adjust_x_right = FALSE )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"base_side_length length side base adjust_x_left Whether base adjusted -x direction (e.g. third base) adjust_x_right Whether base adjusted +x direction (e.g. first base)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"data frame comprises boundary base","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"batter's boxes field. batter must stand legally hit ball","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"","code":"baseball_batters_box( batters_box_length = 0, batters_box_width = 0, batters_box_y_adj = 0, batters_box_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"batters_box_length length batter's box (y direction) measured outside chalk lines batters_box_width width batter's box (x direction) measured outside chalk lines batters_box_y_adj shift center y direction batter's box moved properly align batters_box_thickness thickness chalk lines comprise batter's box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"data frame batter's box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"catcher's box. catcher located defense, usually marked two white lines back line well. box may take various shapes, controlled catchers_box_shape parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"","code":"baseball_catchers_box( catchers_box_depth = 0, catchers_box_width = 0, batters_box_length = 0, batters_box_y_adj = 0, catchers_box_shape = \"rectangle\", catchers_box_thickness = 0, home_plate_circle_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"catchers_box_depth distance back tip home plate back edge catcher's box catchers_box_width distance outer edges catcher's box widest point batters_box_length length batter's box (y direction) measured outside chalk lines batters_box_y_adj shift center y direction batter's box moved properly align catchers_box_shape string representing shape catcher's box draw catchers_box_thickness thickness chalk lines comprise catcher's box home_plate_circle_radius radius circle around home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"data frame containing bounding box catcher's box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"","code":"baseball_features_set_colors( plot_background = \"#395d33\", infield_dirt = \"#9b7653\", infield_grass = \"#395d33\", pitchers_mound = \"#9b7653\", base = \"#ffffff\", pitchers_plate = \"#ffffff\", batters_box = \"#ffffff\", catchers_box = \"#ffffff\", foul_line = \"#ffffff\", running_lane = \"#ffffff\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"plot_background hexadecimal string representing color use feature infield_dirt hexadecimal string representing color use feature infield_grass hexadecimal string representing color use feature pitchers_mound hexadecimal string representing color use feature base hexadecimal string representing color use feature pitchers_plate hexadecimal string representing color use feature batters_box hexadecimal string representing color use feature catchers_box hexadecimal string representing color use feature foul_line hexadecimal string representing color use feature running_lane hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"foul line. white lines extend back tip home plate (visibly batter's boxes) fair/foul pole outfield. Since ball line considered fair territory, outer edge baseline must lie fair territory (aka line y = +/- x)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"","code":"baseball_foul_line( is_line_1b = FALSE, line_distance = 0, batters_box_length = 0, batters_box_width = 0, batters_box_y_adj = 0, home_plate_side_to_batters_box = 0, foul_line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"is_line_1b Whether line first base line line_distance straight-line distance back tip home plate terminus line foul pole batters_box_length length batter's box (y direction) measured outside chalk lines batters_box_width width batter's box (x direction) measured outside chalk lines batters_box_y_adj shift center y direction batter's box moved properly align home_plate_side_to_batters_box distance outer edge batter's box inner edge home plate foul_line_thickness thickness chalk line comprise foul line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"data frame containing foul line's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":null,"dir":"Reference","previous_headings":"","what":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"Home plate. pentagonal shape back tip located origin coordinate system. angled sides home plate intersect baselines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"","code":"baseball_home_plate(home_plate_edge_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"home_plate_edge_length length single edge home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"data frame contains boundary home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":null,"dir":"Reference","previous_headings":"","what":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"home plate circle may drawn shapes needed (example: Detroit's Comerica Park home plate shaped dirt area home plate \"circle\")","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"","code":"baseball_infield_dirt( home_plate_circle_radius = 0, foul_line_to_foul_grass = 0, pitchers_plate_distance = 0, infield_arc_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"home_plate_circle_radius radius circle around home plate foul_line_to_foul_grass distance outer edge foul line inner edge grass foul territory pitchers_plate_distance distance back tip home plate front edge pitcher's plate infield_arc_radius distance front edge pitcher's plate back infield dirt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"data frame comprises entirety infield dirt dirt circles around home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":null,"dir":"Reference","previous_headings":"","what":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"dirt comprises infield grass. area inside lines drawn basepaths","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"","code":"baseball_infield_grass( home_plate_circle_radius = 0, foul_line_to_infield_grass = 0, baseline_distance = 0, base_anchor_to_infield_grass = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"home_plate_circle_radius radius circle around home plate foul_line_to_infield_grass distance outer edge foul line inner edge infield grass baseline_distance distance back tip home plate back corner either first third base along foul line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"data frame comprises entirety infield grass","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":null,"dir":"Reference","previous_headings":"","what":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"pitcher's mound. pitcher's plate located, pitcher's plate necessarily centered pitcher's mound","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"","code":"baseball_pitchers_mound(pitchers_mound_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"pitchers_mound_radius radius pitcher's mound","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"data frame pitcher's mound's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":null,"dir":"Reference","previous_headings":"","what":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"pitcher's plate. pitcher must throw ball . usually long rectangle front edge anchor point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"","code":"baseball_pitchers_plate(pitchers_plate_length = 0, pitchers_plate_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"pitchers_plate_length length (x-direction) pitcher's plate pitchers_plate_width width (y-direction) pitcher's plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"data frame pitcher's plate's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":null,"dir":"Reference","previous_headings":"","what":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"measurements given \"looking line\" (e.g. measured observer standing behind home plate)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"","code":"baseball_running_lane( running_lane_depth = 0, running_lane_length = 0, running_lane_start_distance = 0, running_lane_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"running_lane_depth distance outer edge foul line outer edge running lane running_lane_length total distance running lane, first starts terminus near first base running_lane_start_distance distance back tip home plate running lane starts running_lane_thickness thickness chalk line comprises running lane","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"data frame containing running lane's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":null,"dir":"Reference","previous_headings":"","what":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"backboard backing onto basket ring (created basketball_basket_ring()) affixed. drawn rectangle court court drawn aerial view","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"","code":"basketball_backboard(backboard_width = 0, backboard_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"backboard_width width backboard viewed . x-direction dimension backboard taking point view free throw shooter backboard_thickness thickness backboard viewed ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"data frame bounding box backboard","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":null,"dir":"Reference","previous_headings":"","what":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"explanation math used generate basket ring (connecting portion attaches ring backboard) walked using NBA dimensions, generalized code","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"","code":"basketball_basket_ring( basket_ring_connector_width = 0, backboard_face_to_ring_cent = 0, basket_ring_inner_radius = 0, basket_ring_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"basket_ring_connector_width width basket ring connector backboard_face_to_ring_cent far face backboard center basket ring's circle located basket_ring_inner_radius inner radius circular part basket ring basket_ring_thickness thickness basket ring's circular part","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"data frame boundary basket ring connector","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"connector width 7\", 3.5\" side x axis. ring radius 9\", arcsine measurements give angle point ring connector connect","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"center circle broken two parts: basketball_center_circle_outline(), fill (feature), court coloring inside inner edge circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"","code":"basketball_center_circle_fill(center_circle_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"center_circle_radius outer radius center circle line_thickness thickness line comprises center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"data frame boundary center circle. interior coordinates correspond filled section","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"center circle broken two parts: outline (feature) fill, court coloring inside inner edge circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"","code":"basketball_center_circle_outline(center_circle_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"center_circle_radius outer radius center circle line_thickness thickness line comprises center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"data frame boundary center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"apron court colored boundary around exterior courts. colored boundary exists, take color court floor","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"","code":"basketball_court_apron( court_length = 0, court_width = 0, court_apron_endline = 0, court_apron_sideline = 0, court_apron_to_boundary = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"court_length length court court_width width court court_apron_endline thickness court's apron beyond endline court_apron_sideline thickness court's apron beyond sideline court_apron_to_boundary distance inner edge court apron outer edge court's boundary line (sideline endline spaced ) line_thickness thickness endline sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"data frame bounding coordinates court apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"division line divides court two halves, sometimes referred time line half-court line. center line goes y axis, half line lying team's offensive half court half defensive half court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"","code":"basketball_division_line( court_width = 0, line_thickness = 0, division_line_extension = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"court_width width court line_thickness thickness division line division_line_extension distance division line extends beyond sideline. may omitted value 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"data frame bounding box division line court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":null,"dir":"Reference","previous_headings":"","what":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"endline basketball court, also called baseline, located beyond basket. cases endline court apron, endline still generated color set equal court apron's color (see basketball_court_apron() information court apron)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"","code":"basketball_endline(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"court_width width court line_thickness thickness endline sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"data frame bounding coordinates endline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"","code":"basketball_features_set_colors( plot_background = NULL, defensive_half_court = \"#d2ab6f\", offensive_half_court = \"#d2ab6f\", court_apron = \"#d2ab6f\", center_circle_outline = \"#000000\", center_circle_fill = \"#d2ab6f\", division_line = \"#000000\", endline = \"#000000\", sideline = \"#000000\", two_point_range = \"#d2ab6f\", three_point_line = \"#000000\", painted_area = \"#d2ab6f\", lane_boundary = \"#000000\", free_throw_circle_outline = \"#000000\", free_throw_circle_fill = \"#d2ab6f\", free_throw_circle_dash = \"#000000\", lane_space_mark = \"#000000\", inbounding_line = \"#000000\", substitution_line = \"#000000\", baseline_lower_defensive_box = \"#000000\", lane_lower_defensive_box = \"#000000\", team_bench_line = \"#000000\", restricted_arc = \"#000000\", backboard = \"#000000\", basket_ring = \"#f55b33\", net = \"#ffffff\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"plot_background hexadecimal string representing color use feature defensive_half_court hexadecimal string representing color use feature offensive_half_court hexadecimal string representing color use feature court_apron hexadecimal string representing color use feature center_circle_outline hexadecimal string representing color use feature center_circle_fill hexadecimal string representing color use feature division_line hexadecimal string representing color use feature endline hexadecimal string representing color use feature sideline hexadecimal string representing color use feature two_point_range hexadecimal string representing color use feature three_point_line hexadecimal string representing color use feature painted_area hexadecimal string representing color use feature lane_boundary hexadecimal string representing color use feature free_throw_circle_outline hexadecimal string representing color use feature free_throw_circle_fill hexadecimal string representing color use feature free_throw_circle_dash hexadecimal string representing color use feature lane_space_mark hexadecimal string representing color use feature inbounding_line hexadecimal string representing color use feature substitution_line hexadecimal string representing color use feature baseline_lower_defensive_box hexadecimal string representing color use feature lane_lower_defensive_box hexadecimal string representing color use feature team_bench_line hexadecimal string representing color use feature restricted_arc hexadecimal string representing color use feature backboard hexadecimal string representing color use feature basket_ring hexadecimal string representing color use feature net hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"outline free throw circle. interior filling area created via basketball_free_throw_circle_fill()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"","code":"basketball_free_throw_circle( overhang = 0, free_throw_circle_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"overhang arc length free throw circle hangs past free throw line free_throw_circle_radius radius free throw circle line_thickness thickness free throw line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"data frame bounding coordinates free throw circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":null,"dir":"Reference","previous_headings":"","what":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"courts, series dashes comprise bottom half free throw circle (e.g. half closer basket). function generates single dash","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"","code":"basketball_free_throw_circle_dash( feature_radius = 0, line_thickness = 0, start_angle = 0, end_angle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"feature_radius radius free throw circle line_thickness thickness dash start_angle angle, radians / pi, dash start end_angle angle, radians / pi, dash end","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"data frame containing bounding coordinates dash free throw circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"filled-section free throw circle. circle area free throw shooter stands attempting free throw. outline area created separately via basketball_free_throw_circle()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"","code":"basketball_free_throw_circle_fill( free_throw_circle_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"free_throw_circle_radius outer radius free throw circle, measured center free throw line line_thickness thickness outline free throw circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"data frame containing bounding coordinates free throw circle's semi-circular filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"NOTE: include lane space markings (blocks), created via basketball_lane_space_mark().","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"","code":"basketball_free_throw_lane_boundary( lane_length = 0, lane_width = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"lane_length length free throw lane lane_width width free throw line_thickness thickness free throw lane boundary","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"data frame bounding coordinates free throw lane boundary","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":null,"dir":"Reference","previous_headings":"","what":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"half court spans inner edge baseline center division line, serves base layer court plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"","code":"basketball_half_court(court_length = 0, court_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"court_length length court court_width width court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"data frame bounding box half basketball court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"inbounding line ball inbounded sideline necessary. Lines drawn top court drawn top-direction, lines bottom court drawn bottom-direction","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"","code":"basketball_inbounding_line( line_thickness = 0, in_play_ext = 0, out_of_bounds_ext = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"line_thickness thickness inbounding line in_play_ext extension inbounding line court out_of_bounds_ext extension inbounding line away court drawn_direction string indicating way, un-rotated plot, line drawn looking plot TV View","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"data frame containing bounding box inbounding line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"lane space marks, also known blocks, denote non-shooting players stand free throws. Players may cross lines ball touches rim shot attempt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"","code":"basketball_lane_space_mark(feature_thickness = 0, mark_depth = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"feature_thickness thickness lane space mark (distance x direction \"TV View\") mark_depth distance exterior edge free throw lane boundary lane space mark extends towards sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"data frame containing bounding box lane space mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"lower defensive box imaginary box court extending lines baseline lines inside painted area. box helps determine block/charge call take place, offensive player entitled move outside (subsequently enter) box without contact","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"","code":"basketball_lower_defensive_box_mark( drawn_direction = \"\", extension = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"drawn_direction string indicating way draw lower defensive box mark extension amount lower defensive box mark extends drawn direction line_thickness thickness line representing lower defensive box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"data frame bounding box lower defensive box marking","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":null,"dir":"Reference","previous_headings":"","what":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"make basket ring easier identify, nets also drawn onto plot. typically white color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"","code":"basketball_net(basket_ring_inner_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"basket_ring_inner_radius radius interior basket ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"data frame net's circular outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"painted area may different color rest two point range area (see basketball_two_point_range() information two-point range), may also color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"","code":"basketball_painted_area( lane_length = 0, lane_width = 0, paint_margin = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"lane_length length free throw lane lane_width width free throw paint_margin distance painted area lane free throw lane boundary lines line_thickness thickness line free throw lane boundary line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"data frame bounding coordinates free throw lane's painted area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":null,"dir":"Reference","previous_headings":"","what":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"arc located free-throw lane called restricted arc. interior radius specified feature.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"","code":"basketball_restricted_arc( feature_radius = 0, line_thickness = 0, backboard_to_center_of_basket = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"feature_radius interior radius restricted arc line_thickness thickness restricted arc line backboard_to_center_of_basket distance backboard center basket","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"data frame containing bounding coordinates restricted arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"sideline basketball court run full length court, typically team bench areas substitution areas exterior. cases sideline court apron, sideline still generated color set equal court apron's color (see basketball_court_apron() information court apron)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"","code":"basketball_sideline(court_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"court_length length court line_thickness thickness endline sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"data frame bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"substitution line players checking game wait stoppage. Lines drawn top court drawn top-direction, lines bottom court drawn bottom-direction","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"","code":"basketball_substitution_line( line_thickness = 0, substitution_line_width = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"line_thickness thickness substitution line substitution_line_width width substitution line, top bottom viewing plot TV view drawn_direction string indicating way, un-rotated plot, line drawn looking plot TV View","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"data frame containing bounding coordinates substitution line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":null,"dir":"Reference","previous_headings":"","what":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"Players game must stay within team bench lines unless moving substitution area (see basketball_substitution_line() class)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"","code":"basketball_team_bench_line( line_thickness = 0, extension = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"line_thickness thickness team bench line extension extension team bench line court drawn_direction string indicating way, un-rotated plot, line drawn looking plot TV View","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"data frame containing bounding coordinates team bench line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":null,"dir":"Reference","previous_headings":"","what":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"Start getting distance center basket corner three-point shot. referred start_y","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"","code":"basketball_three_point_line( basket_center_to_baseline = 0, basket_center_to_corner_three = 0, line_thickness = 0, three_point_line_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"basket_center_to_baseline distance center basket ring inner edge baseline basket_center_to_corner_three distance center basket ring outer edge three-point line corner court's specified units line_thickness thickness three-point line three_point_line_radius outer radius arc portion three-point line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"data frame bounding coordinates three-point line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"Next, get starting angle trace two-point range. Taking distance start_y y coordinate, radius arc three-point line radius, sine starting angle given start_y / three_point_arc_radius TV-right angle start arc drawn , starting ending angles need adjusted relative 1 radian (arc opens right, like ( character) starting angle therefore given 1 - angle, ending angle 1 + angle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":null,"dir":"Reference","previous_headings":"","what":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"also noted corresponds strictly area contained three-point line, interior angle needed. utilizing corner-three distance outer edge work generally, issue may arise z-order feature's plotting characteristic changed greater three-point line . happen, interior edge therefore used ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"","code":"basketball_two_point_range( basket_center_to_baseline = 0, basket_center_to_corner_three = 0, line_thickness = 0, two_point_range_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"basket_center_to_baseline distance center basket ring inner edge baseline basket_center_to_corner_three distance center basket ring outer edge three-point line corner court's specified units line_thickness thickness three-point line two_point_range_radius radius arc portion three-point line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"data frame bounding coordinates two-point range","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"Start getting distance center basket corner three-point shot. referred start_y Next, get starting angle trace two-point range. Taking distance start_y y coordinate, (outer) radius arc three-point line radius, sine starting angle given start_y / {three_point_arc_radius - three_point_line_thickness} TV-right angle start arc drawn , starting ending angles need adjusted relative 1 radian (arc opens right, like ( character) starting angle therefore given 1 - angle, ending angle 1 + angle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":null,"dir":"Reference","previous_headings":"","what":"Check to see what features of a surface can be colored — cani_color_league_features","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"Check see features surface can colored","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"","code":"cani_color_league_features(league_code, sport_name = NULL)"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"league_code case-insensitive league code plotted sport_name name sport use event league_code supplied one sport associated . Default: NULL","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"Nothing, message sent console","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"","code":"cani_color_league_features(\"NCAA\", \"basketball\") #> Here are the viable plotting features to color for NCAA basketball: #> #> plot_background #> defensive_half_court #> offensive_half_court #> court_apron #> center_circle_outline #> center_circle_fill #> division_line #> endline #> sideline #> two_point_range #> three_point_line #> painted_area #> lane_boundary #> free_throw_circle_outline #> free_throw_circle_fill #> free_throw_circle_dash #> lane_space_mark #> inbounding_line #> substitution_line #> baseline_lower_defensive_box #> lane_lower_defensive_box #> team_bench_line #> restricted_arc #> backboard #> basket_ring #> net"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":null,"dir":"Reference","previous_headings":"","what":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"Check see league can plotted, alert function(s) league work ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"","code":"cani_plot_league(league_code)"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"league_code case-insensitive league code plotted","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"Nothing, message sent console","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"","code":"cani_plot_league(\"MLB\") #> A plot for MLB can be created via the geom_baseball() function"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":null,"dir":"Reference","previous_headings":"","what":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"Check see sport can plotted, alert league(s) plottable sport","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"","code":"cani_plot_sport(sport_code)"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"sport_code case-insensitive sport name","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"Nothing, message sent console","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"","code":"cani_plot_sport(\"basketball\") #> geom_basketball() can be used to plot for the following leagues: FIBA, NBA, NBA G LEAGUE, NCAA, NFHS, WNBA"},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert all units, regardless of starting and ending units — convert_units","title":"Convert all units, regardless of starting and ending units — convert_units","text":"Convert units, regardless starting ending units","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert all units, regardless of starting and ending units — convert_units","text":"","code":"convert_units(meas, from_unit, to_unit, conversion_columns = NULL)"},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert all units, regardless of starting and ending units — convert_units","text":"meas measurement unit length from_unit string containing original unit measure converted to_unit string containing ending unit measure conversion_columns vector containing columns convert meas type data.frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert all units, regardless of starting and ending units — convert_units","text":"measurement converted units","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert all units, regardless of starting and ending units — convert_units","text":"","code":"convert_units(1, \"in\", \"cm\") #> [1] 2.54 convert_units(100, \"cm\", \"m\") #> [1] 1"},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"Create set x y coordinates form circle (arc circle)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"","code":"create_circle(center = c(0, 0), npoints = 1000, r = 1, start = 0, end = 2)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"center (x, y) coordinates center circle. Default: (0, 0) npoints number points create circle. also length resulting data frame. Default: 1000 r radius circle UNITS PLOT. default unit feet. Default: 1 (unit circle) start angle (radians, divided pi) start drawing circle, zero runs along +x axis. Default: 0 end angle (radians, divided pi) stop drawing circle, zero runs along +x axis. Default: 2","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"data frame containing points needed draw specified circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"Create set x y coordinates form diamond. function wrapper create_rectangle() ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"","code":"create_diamond(height, width, center = c(0, 0))"},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"height vertical height diamond width horizontal width diamond center center coordinates diamond","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"data frame containing points needed draw specified diamond","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":null,"dir":"Reference","previous_headings":"","what":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"Create base ggplot2 instance correct theme elements","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"","code":"create_plot_base(plot_background = NULL)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"plot_background hexadecimal string representing color use plot's background. Default: NULL","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"ggplot2 instance onto features added","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a rectangle — create_rectangle","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"Create set x y coordinates form rectangle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"","code":"create_rectangle(x_min, x_max, y_min, y_max)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"x_min minimum value x x_max maximum value x y_min minimum value y y_max maximum value y","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"data frame containing points needed draw specified rectangle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"Create set x y coordinates form square. function wrapper create_rectangle() ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"","code":"create_square(side_length, center = c(0, 0))"},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"side_length length side square center center coordinates square","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"data frame containing points needed draw specified square","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form an ","title":"Create a set of x and y coordinates that form an ","text":"Create set x y coordinates form \"X\"-like shape","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form an ","text":"","code":"create_x_shape(bar_length, bar_width, rotation = 45)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form an ","text":"bar_length length one bars forms \"X\" shape, outer edge outer edge bar_width width one bars forms \"X\" shape, outer edge outer edge rotation angle rotation (degrees) resulting \"X\"-like shape rotated","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form an ","text":"data frame containing points needed draw specified \"X\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"back line line back house. outer edge used anchor point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"","code":"curling_back_line(line_thickness = 0, sheet_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"line_thickness thickness back line sheet_width width curling sheet, side wall side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"data frame containing bounding box back line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":null,"dir":"Reference","previous_headings":"","what":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"inner-concentric circles comprising house called button. intersection tee line (see curling_tee_line()) centre line (see curling_centre_line())","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"","code":"curling_button(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"feature_radius radius button","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"data frame containing bounding coordinates button","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"centre line line runs full length curling sheet, line x = 0 TV view","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"","code":"curling_centre_line( line_thickness = 0, tee_line_to_center = 0, centre_line_extension = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"line_thickness thickness centre line tee_line_to_center distance tee lines. (See curling_tee_line() information) centre_line_extension distance beyond tee lines centre line extends","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"data frame containing bounding coordinates centre line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"curling sheet entire sheet, houses either top bottom ends. draws area hog lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"","code":"curling_centre_zone( sheet_width = 0, tee_line_to_center = 0, hog_line_to_tee_line = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"sheet_width width curling sheet, side wall side wall tee_line_to_center distance tee line center sheet hog_line_to_tee_line distance center tee line interior edge tee line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"data frame containing bounding box end ice sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"courtesy lines players stand delivery process stone opposing team throwing","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"","code":"curling_courtesy_line(line_thickness = 0, line_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"line_thickness thickness courtesy line line_length length courtesy line, side wall towards centre line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"data frame containing bounding box courtesy line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":null,"dir":"Reference","previous_headings":"","what":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"curling sheet entire sheet, houses either top bottom ends. draws area sheet hog line back board","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"","code":"curling_end( sheet_length = 0, sheet_width = 0, tee_line_to_center = 0, hog_line_to_tee_line = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"sheet_length length sheet, back board back board sheet_width width curling sheet, side wall side wall tee_line_to_center distance tee line center sheet hog_line_to_tee_line distance center tee line interior edge tee line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"data frame containing bounding box end ice sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"","code":"curling_features_set_colors( plot_background = NULL, end_1 = \"#ffffff\", centre_zone = \"#ffffff\", end_2 = \"#ffffff\", sheet_apron = \"#0033a0\", centre_line = \"#000000\", tee_line = \"#000000\", back_line = \"#000000\", hog_line = \"#c8102e\", hack_line = \"#000000\", courtesy_line = \"#000000\", hack = \"#000000\", button = \"#ffffff\", house_rings = c(\"#c8102e\", \"#ffffff\", \"#0033a0\") )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"plot_background hexadecimal string representing color use feature end_1 hexadecimal string representing color use feature end_2 hexadecimal string representing color use feature sheet_apron hexadecimal string representing color use feature centre_line hexadecimal string representing color use feature tee_line hexadecimal string representing color use feature back_line hexadecimal string representing color use feature hog_line hexadecimal string representing color use feature hack_line hexadecimal string representing color use feature courtesy_line hexadecimal string representing color use feature hack hexadecimal string representing color use feature button hexadecimal string representing color use feature house_rings vector hexadecimal strings representing color(s) use feature center_zone hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":null,"dir":"Reference","previous_headings":"","what":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"hack exits sides curling sheet back board back line. curler pushes , centered centre line (see curling_centre_line()). function draws one footholds hack","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"","code":"curling_hack_foothold(foothold_depth = 0, foothold_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"foothold_depth depth foothold hack, side nearest house side nearest back board foothold_width width foothold hack, side nearest centre line side nearest nearest side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"data frame containing bounding box one foothold hack","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"hack line connects two footholds hack. anchored terminus centre line (see curling_centre_line() information)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"","code":"curling_hack_line(line_thickness = 0, hack_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"line_thickness thickness hack line hack_width width hack, measured outside one foothold outside ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"data frame containing bounding box hack line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"hog line line begins Free Guard Zone end ice. inner edge (relative nearest house) used anchor point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"","code":"curling_hog_line(line_thickness = 0, sheet_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"line_thickness thickness hog line sheet_width width curling sheet, side wall side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"data frame containing bounding box hog line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":null,"dir":"Reference","previous_headings":"","what":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"house comprised three concentric circles outside button varying radii. feature designed house rings excluding button","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"","code":"curling_house_ring(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"feature_radius radius ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"data frame containing bounding coordinates house ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"apron sheet separates adjacent sheets, context provides border around outside sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"","code":"curling_sheet_apron( sheet_length = 0, sheet_width = 0, apron_behind_back = 0, apron_along_side = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"sheet_length length sheet, back board back board sheet_width width curling sheet, side wall side wall apron_behind_back extension apron beyond back board apron_along_side extension apron running along side walls","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"data frame containing bounding coordinates sheet's apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"tee line line runs center house. midpoints connected centre line (see curling_centre_line() information)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"","code":"curling_tee_line(line_thickness = 0, sheet_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"line_thickness thickness tee line sheet_width width curling sheet, side wall side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"data frame containing bounding box tee line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Euclidean distance between two points — distance_formula","title":"Get the Euclidean distance between two points — distance_formula","text":"Get Euclidean distance two points","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Euclidean distance between two points — distance_formula","text":"","code":"distance_formula(point_1_x, point_1_y, point_2_x = 0, point_2_y = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the Euclidean distance between two points — distance_formula","text":"point_1_x point's (vector points') x coordinate point_1_y point's (vector points') y coordinate point_2_x point's (vector points') x coordinate point_2_y point's (vector points') y coordinate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Euclidean distance between two points — distance_formula","text":"distance two supplied points","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"coaching box area restricted area team bench area. may may distinct either areas, typically separated coaching box line (see football_coaching_box_line() information coaching box line)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"","code":"football_coaching_box(coaching_box_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"coaching_box_length length coaching box feature_thickness depth beyond exterior edge restricted area coaching box protrudes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"data frame bounding box coaching box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"coaching box line line separates team bench area coaching box. line different color bench area coaching box, may color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"","code":"football_coaching_box_line(coaching_box_line_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"coaching_box_line_length length line forming coaching box line feature_thickness thickness draw line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"data frame bounding box coaching box line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":null,"dir":"Reference","previous_headings":"","what":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"directional arrows point towards nearest goal line yardage marker closest . arrows described base (runs parallel goal line) length, extends tip base","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"","code":"football_directional_arrow(arrow_base = 0, arrow_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"arrow_base length base arrow arrow_length length arrow tip base","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"data frame bounding coordinates directional arrow","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"end line line beyond back endzone. interior edge considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"","code":"football_end_line(feature_thickness = 0, field_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"feature_thickness thickness boundary lines field_width width field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"data frame bounding box end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":null,"dir":"Reference","previous_headings":"","what":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"endzones area beyond goal line. offensive player legal possession ball endzone, catches ball endzone, scores touchdown team. area stretches back field boundary edge goal line closest center field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"","code":"football_endzone(field_width = 0, endzone_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"field_width width field endzone_length length endzone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"data frame bounding box endzone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"","code":"football_features_set_colors( plot_background = NULL, field_apron = \"#196f0c\", offensive_half = \"#196f0c\", defensive_half = \"#196f0c\", offensive_endzone = \"#196f0c\", defensive_endzone = \"#196f0c\", end_line = \"#ffffff\", sideline = \"#ffffff\", field_border = \"#196f0c\", field_border_outline = \"#ffffff00\", red_zone_border = \"#196f0c00\", red_zone_border_outline = \"#ffffff00\", major_yard_line = \"#ffffff\", goal_line = \"#ffffff\", minor_yard_line = \"#ffffff\", directional_arrow = \"#ffffff\", try_mark = \"#ffffff\", yardage_marker = \"#ffffff\", restricted_area = \"#ffffff\", coaching_box = \"#ffffff\", team_bench_area = \"#196f0c\", team_bench_area_outline = \"#ffffff\", coaching_box_line = \"#ffcb05\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"plot_background hexadecimal string representing color use feature field_apron hexadecimal string representing color use feature offensive_half hexadecimal string representing color use feature defensive_half hexadecimal string representing color use feature offensive_endzone hexadecimal string representing color use feature defensive_endzone hexadecimal string representing color use feature end_line hexadecimal string representing color use feature sideline hexadecimal string representing color use feature field_border hexadecimal string representing color use feature field_border_outline hexadecimal string representing color use feature red_zone_border hexadecimal string representing color use feature red_zone_border_outline hexadecimal string representing color use feature major_yard_line hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature minor_yard_line hexadecimal string representing color use feature directional_arrow hexadecimal string representing color use feature try_mark hexadecimal string representing color use feature yardage_marker hexadecimal string representing color use feature restricted_area hexadecimal string representing color use feature coaching_box hexadecimal string representing color use feature team_bench_area hexadecimal string representing color use feature team_bench_area_outline hexadecimal string representing color use feature coaching_box_line hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"field apron appropriately see --bounds features. typically color field , created separately allow customized plotting","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"","code":"football_field_apron( field_length = 0, field_width = 0, endzone_length = 0, boundary_thickness = 0, field_border_thickness = 0, restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, team_bench_area_border_thickness = 0, extra_apron_padding = 0, bench_shape = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"field_length length field field_width width field endzone_length length endzone boundary_thickness thickness field boundary field_border_thickness thickness field border restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length team bench area nearest field team_bench_length_back_side length team bench area furthest field team_bench_width width team bench area team_bench_area_border_thickness thickness border around team bench area extra_apron_padding additional distance add apron field bench_shape string shape bench. Currently, checks \"rectangle\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"data frame bounding coordinates field apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":null,"dir":"Reference","previous_headings":"","what":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"field border border line around outer edge sideline end line. may present every field, sideline end line (although may color)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"","code":"football_field_border( field_length = 0, field_width = 0, feature_thickness = 0, endzone_length = 0, boundary_line_thickness = 0, restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, team_bench_area_border_thickness = 0, surrounds_team_bench_area = FALSE, bench_shape = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"field_length length field field_width width field feature_thickness thickness field border endzone_length length endzone boundary_line_thickness thickness boundary lines restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length side team bench closest field team_bench_length_back_side length side team bench furthest field team_bench_width width team bench team_bench_area_border_thickness thickness border around team bench surrounds_team_bench_area boolean whether field border surround team bench bench_shape string shape bench. Currently, checks \"rectangle\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"data frame bounding box field border","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"field border's outline outline around outer edge field border. may present every field, sideline end line (although may color)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"","code":"football_field_border_outline( field_length = 0, field_width = 0, feature_thickness = 0, endzone_length = 0, boundary_line_thickness = 0, restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, team_bench_area_border_thickness = 0, field_border_thickness = 0, surrounds_team_bench_area = TRUE, bench_shape = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"field_length length field field_width width field feature_thickness thickness field border's outline endzone_length length endzone boundary_line_thickness thickness boundary lines restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length side team bench closest field team_bench_length_back_side length side team bench furthest field team_bench_width width team bench team_bench_area_border_thickness thickness border around team bench field_border_thickness thickness field border surrounds_team_bench_area boolean whether field border surround team bench bench_shape string shape bench. Currently, checks \"rectangle\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"data frame bounding box field border's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"goal lines lines ball must cross either passed ran order score touchdown. interior edge goal line (relative center field play) lie 0 yard line, center 1 yard line exactly 1 yard edge goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"","code":"football_goal_line(field_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"field_width width field feature_thickness thickness goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"data frame bounding box goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":null,"dir":"Reference","previous_headings":"","what":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"half football field spans edge goal line nearest midfield center major yard line midfield","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"","code":"football_half_field(field_length = 0, field_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"field_length length field field_width width field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"data frame bounding box half football field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"major yard lines yard lines span entire width field. Typically, lines placed every 5 yards, customization left user. lines may feature cross-hash, runs x-direction","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"","code":"football_major_yard_line( field_width = 0, feature_thickness = 0, dist_to_sideline = 0, cross_hash_length = 0, cross_hash_separation = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"field_width width field feature_thickness thickness major yard lines dist_to_sideline distance end yard line interior edge sideline cross_hash_length length cross-hash mark cross_hash_separation interior separation cross-hashes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"data frame containing bounding box major yard lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"minor yard lines yard lines major yard lines. Typically, four sets minor yard lines: one near sideline, two near middle field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"","code":"football_minor_yard_line(yard_line_height = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"yard_line_height height (y-direction) yard line feature_thickness thickness minor yard line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"data frame bounding box minor yard line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":null,"dir":"Reference","previous_headings":"","what":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"field border (see football_field_border()) may different color along red zone along rest field. always case, feature provided convenience","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"","code":"football_red_zone_border(feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"feature_thickness thickness field border","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"data frame bounding box red zone border","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"outline football_red_zone_border() may different color rest field border. always case, feature provided convenience","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"","code":"football_red_zone_border_outline(feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"feature_thickness thickness field border's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"data frame bounding box red zone border's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"restricted area area nearest sideline's exterior edge. area distinct coaching box (immediately behind restricted area) team bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"","code":"football_restricted_area(restricted_area_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"restricted_area_length length restricted area feature_thickness depth beyond exterior edge sideline restricted area protrudes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"data frame bounding coordinates restricted area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"sidelines lines run length field, stretching back one endzone back endzone. interior edge considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"","code":"football_sideline(feature_thickness = 0, field_length = 0, endzone_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"feature_thickness thickness boundary lines field_length length field endzone_length length endzone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"data frame bounding box sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"team bench area area beyond restricted area coaching box. team benches, non-playing players, team staff remain game","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"","code":"football_team_bench_area( team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"team_bench_length_field_side length side team bench area closest field team_bench_length_back_side length side team bench area furthest field team_bench_width depth beyond outer edge coaching box line team bench area protrudes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"data frame bounding coordinates team bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"outline team bench area runs beyond team bench, inside field border may run behind team bench area (see football_field_border() information feature)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"","code":"football_team_bench_area_outline( restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, feature_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length side team bench closest field team_bench_length_back_side length side team bench furthest field team_bench_width width team bench feature_thickness thickness outline team bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"data frame containing bounding coordinates team bench area's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"try mark mark tries start. line located directly line y = 0. line typically considered official yard line, created independently","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"","code":"football_try_mark(try_mark_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"try_mark_width width (y-direction) try mark feature_thickness thickness try mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"data frame bounding box try mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"Generate ggplot2 instance containing baseball field specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"","code":"geom_baseball( league, display_range = \"full\", field_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, field_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full field. default \"infield\" infield baseball field field_updates list updates field's parameters. overwrite parameters league color_updates list updates field's default colors, set baseball_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends back tip home plate towards left-handed batter's box (first base side field) y_trans amount y coordinates shifted. convention, +y axis extends back tip home plate towards straight-away center field field_units units draw field. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"ggplot2 instance full-surface representation baseball field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"","code":"if (FALSE) { geom_baseball(league = \"MLB\", rotation = 270, display_range = \"infield\") geom_baseball(league = \"little league\", field_units = \"m\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"Generate ggplot2 instance containing basketball court specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"","code":"geom_basketball( league, display_range = \"full\", court_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full court. default \"in_bounds_only\" full -bounds area court \"bounds \" full -bounds area court \"offense\" TV-right half court half-court. considered offensive half court \"offence\" TV-right half court half-court. considered offensive half court \"offensivehalfcourt\" TV-right half court half-court. considered offensive half court \"offensive_half_court\" TV-right half court half-court. considered offensive half court \"offensive half court\" TV-right half court half-court. considered offensive half court \"defense\" TV-left half court half-court. considered defensive half court \"defence\" TV-left half court half-court. considered defensive half court \"defensivehalfcourt\" TV-left half court half-court. considered defensive half court \"defensive_half_court\" TV-left half court half-court. considered defensive half court \"defensive half court\" TV-left half court half-court. considered defensive half court \"offensivekey\" TV-right offensive key (three-point line two-point range) \"offensive_key\" TV-right offensive key (three-point line two-point range) \"offensive key\" TV-right offensive key (three-point line two-point range) \"attackingkey\" TV-right offensive key (three-point line two-point range) \"attacking_key\" TV-right offensive key (three-point line two-point range) \"attacking key\" TV-right offensive key (three-point line two-point range) \"defensivekey\" TV-left defensive key (three-point line two-point range) \"defensive_key\" TV-left defensive key (three-point line two-point range) \"defensive key\" TV-left defensive key (three-point line two-point range) \"defendingkey\" TV-left defensive key (three-point line two-point range) \"defending_key\" TV-left defensive key (three-point line two-point range) \"defending key\" TV-left defensive key (three-point line two-point range) \"offensivepaint\" TV-right offensive free-throw lane \"offensive_paint\" TV-right offensive free-throw lane \"offensive paint\" TV-right offensive free-throw lane \"attackingpaint\" TV-right offensive free-throw lane \"attacking_paint\" TV-right offensive free-throw lane \"attacking paint\" TV-right offensive free-throw lane \"offensivelane\" TV-right offensive free-throw lane \"offensive_lane\" TV-right offensive free-throw lane \"offensive lane\" TV-right offensive free-throw lane \"attackinglane\" TV-right offensive free-throw lane \"attacking_lane\" TV-right offensive free-throw lane \"attacking lane\" TV-right offensive free-throw lane \"defensivepaint\" TV-left defensive free-throw lane \"defensive_paint\" TV-left defensive free-throw lane \"defensive paint\" TV-left defensive free-throw lane \"defendingpaint\" TV-left defensive free-throw lane \"defending_paint\" TV-left defensive free-throw lane \"defending paint\" TV-left defensive free-throw lane \"defensivelane\" TV-left defensive free-throw lane \"defensive_lane\" TV-left defensive free-throw lane \"defensive lane\" TV-left defensive free-throw lane \"defendinglane\" TV-left defensive free-throw lane \"defending_lane\" TV-left defensive free-throw lane \"defending lane\" TV-left defensive free-throw lane court_updates list updates courts' parameters. overwrite parameters league color_updates list updates courts' default colors, set basketball_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center court towards right-hand basket viewing court TV View y_trans amount y coordinates shifted. convention, +y axis extends center court towards top court viewing court TV view court_units units draw court. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"ggplot2 instance full-surface representation basketball court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"","code":"if (FALSE) { geom_basketball(league = \"NBA\", rotation = 270, display_range = \"offense\") geom_basketball(league = \"fiba\", court_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"Generate ggplot2 instance containing curling sheet specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"","code":"geom_curling( league, display_range = \"full\", sheet_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, sheet_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full sheet. default \"in_bounds_only\" full -bounds area sheet \"bounds \" full -bounds area sheet \"house\" single house, defaults top house TV view sheet_updates list updates sheet's parameters. overwrite parameters league color_updates list updates sheet's default colors, set curling_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center sheet towards right-hand goal viewing sheet TV View y_trans amount y coordinates shifted. convention, +y axis extends center sheet towards top sheet viewing sheet TV view sheet_units units draw sheet. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"ggplot2 instance full-surface representation curling sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"","code":"if (FALSE) { geom_curling(league = \"wcf\", rotation = 270, display_range = \"house\") geom_curling(league = \"wcf\", sheet_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"Generate ggplot2 instance containing football field specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"","code":"geom_football( league, display_range = \"full\", field_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, field_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full field. default \"in_bounds_only\" full -bounds area field \"bounds \" full -bounds area field \"offense\" TV-right half field \"offence\" TV-right half field \"offensivehalffield\" TV-right half field \"offensive_half_field\" TV-right half field \"offensive half field\" TV-right half field \"defense\" TV-left half field \"defence\" TV-left half field \"defensivehalffield\" TV-left half field \"defensive_half_field\" TV-left half field \"defensive half field\" TV-left half field \"redzone\" offensive red zone field. definition 20 yards goal line \"red_zone\" offensive red zone field. definition 20 yards goal line \"red zone\" offensive red zone field. definition 20 yards goal line \"oredzone\" offensive red zone field. definition 20 yards goal line \"offensive_red_zone\" offensive red zone field. definition 20 yards goal line \"offensive red zone\" offensive red zone field. definition 20 yards goal line \"dredzone\" defensive red zone field. definition 20 yards goal line \"defensive_red_zone\" defensive red zone field. definition 20 yards goal line \"defensive red zone\" defensive red zone field. definition 20 yards goal line field_updates list updates field's parameters. overwrite parameters league color_updates list updates field's default colors, set football_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center field towards right-hand endzone viewing field TV View y_trans amount y coordinates shifted. convention, +y axis extends center field towards sideline viewing field TV view field_units units draw field. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"ggplot2 instance full-surface representation football field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"","code":"if (FALSE) { geom_football(league = \"NFL\", rotation = 270, display_range = \"red_zone\") geom_football(league = \"cfl\", field_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"Generate ggplot2 instance containing ice rink specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"","code":"geom_hockey( league, display_range = \"full\", rink_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, rink_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full ice surface. default \"in_bounds_only\" full -bounds area rink \"bounds \" full -bounds area rink \"offense\" TV-right half rink \"offence\" TV-right half rink \"defense\" TV-left half rink \"defence\" TV-left half rink \"ozone\" TV-right zone rink \"offensive_zone\" TV-right zone rink \"offensive zone\" TV-right zone rink \"attacking_zone\" TV-right zone rink \"attacking zone\" TV-right zone rink \"dzone\" TV-left zone rink \"defensive_zone\" TV-left zone rink \"defensive zone\" TV-left zone rink \"defending_zone\" TV-left zone rink \"defending zone\" TV-left zone rink \"nzone\" middle zone rink \"neutral\" middle zone rink \"neutral_zone\" middle zone rink \"neutral zone\" middle zone rink rink_updates list updates rink's parameters. overwrite parameters league color_updates list updates courts' default colors, set hockey_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center ice surface towards right-hand goal viewing rink TV View y_trans amount y coordinates shifted. convention, +y axis extends center ice surface towards top rink viewing rink TV view rink_units units draw rink. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"ggplot2 instance full-surface representation ice hockey rink","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"","code":"if (FALSE) { geom_hockey(league = \"NHL\", rotation = 270, display_range = \"ozone\") geom_hockey(league = \"iihf\", rink_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"Generate ggplot2 instance containing lacrosse field specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"","code":"geom_lacrosse( league, display_range = \"full\", field_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, field_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full field. default \"offense\" offensive half field. right half field TV view \"offence\" offensive half field. right half field TV view \"offensivehalffield\" offensive half field. right half field TV view \"offensive_half_field\" offensive half field. right half field TV view \"offensive half field\" offensive half field. right half field TV view \"defense\" defensive half field. left half field TV view \"defence\" defensive half field. left half field TV view \"defensivehalffield\" defensive half field. left half field TV view \"defensive_half_field\" defensive half field. left half field TV view \"defensive half field\" defensive half field. left half field TV view field_updates list updates fields' parameters. overwrite parameters league color_updates list updates fields' default colors, set lacrosse_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center field towards right-hand basket viewing field TV View y_trans amount y coordinates shifted. convention, +y axis extends center field towards top field viewing field TV view field_units units draw field. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"ggplot2 instance full-surface representation lacrosse field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"","code":"if (FALSE) { geom_lacrosse(league = \"NCAA\", rotation = 270, display_range = \"offense\") geom_lacrosse(league = \"FIVB\", field_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"Generate ggplot2 instance containing soccer pitch specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"","code":"geom_soccer( league, display_range = \"full\", pitch_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, pitch_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full pitch. default \"in_bounds_only\" full -bounds area pitch \"bounds \" full -bounds area pitch \"offense\" TV-right half pitch \"offence\" TV-right half pitch \"offensivehalfpitch\" TV-right half pitch \"offensive_half_pitch\" TV-right half pitch \"offensive half pitch\" TV-right half pitch \"defense\" TV-left half pitch \"defence\" TV-left half pitch \"defensivehalfpitch\" TV-left half pitch \"defensive_half_pitch\" TV-left half pitch \"defensive half pitch\" TV-left half pitch pitch_updates list updates pitch's parameters. overwrite parameters league color_updates list updates pitch's default colors, set soccer_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center pitch towards right-hand goal viewing pitch TV View y_trans amount y coordinates shifted. convention, +y axis extends center pitch towards top pitch viewing pitch TV view pitch_units units draw pitch. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"ggplot2 instance full-surface representation soccer pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"","code":"if (FALSE) { geom_soccer(league = \"EPL\", rotation = 270, display_range = \"offense\") geom_soccer(league = \"fifa\", pitch_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"Generate ggplot2 instance containing tennis court specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"","code":"geom_tennis( league, display_range = \"full\", court_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full court. default \"in_bounds_only\" full -bounds area court \"bounds \" full -bounds area court \"serve\" serving half court \"serving\" serving half court \"servicehalf\" serving half court \"service_half\" serving half court \"service half\" serving half court \"servinghalf\" serving half court \"serving_half\" serving half court \"serving half\" serving half court \"receive\" receiving half court \"receiving\" receiving half court \"receivicehalf\" receiving half court \"receivice_half\" receiving half court \"receivice half\" receiving half court \"receivinghalf\" receiving half court \"receiving_half\" receiving half court \"receiving half\" receiving half court court_updates list updates courts' parameters. overwrite parameters league color_updates list updates courts' default colors, set tennis_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center court towards right-hand serviceline viewing court TV View y_trans amount y coordinates shifted. convention, +y axis extends center court towards sideline viewing court TV view court_units units draw court. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"ggplot2 instance full-surface representation tennis court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"","code":"if (FALSE) { geom_tennis(league = \"USTA\", rotation = 270, display_range = \"serving\") geom_tennis(league = \"itf\", court_units = \"m\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"Generate ggplot2 instance containing volleyball court specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"","code":"geom_volleyball( league, display_range = \"full\", court_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full court. default \"in_bounds_only\" full -bounds area court \"bounds \" full -bounds area court \"offense\" offensive half court. right half court TV view \"offence\" offensive half court. right half court TV view \"offensivehalfcourt\" offensive half court. right half court TV view \"offensive_half_court\" offensive half court. right half court TV view \"offensive half court\" offensive half court. right half court TV view \"defense\" defensive half court. left half court TV view \"defence\" defensive half court. left half court TV view \"defensivehalfcourt\" defensive half court. left half court TV view \"defensive_half_court\" defensive half court. left half court TV view \"defensive half court\" defensive half court. left half court TV view court_updates list updates courts' parameters. overwrite parameters league color_updates list updates courts' default colors, set volleyball_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center court towards right-hand basket viewing court TV View y_trans amount y coordinates shifted. convention, +y axis extends center court towards top court viewing court TV view court_units units draw court. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"ggplot2 instance full-surface representation volleyball court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"","code":"if (FALSE) { geom_volleyball(league = \"NCAA\", rotation = 270, display_range = \"offense\") geom_volleyball(league = \"FIVB\", court_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the default value when not provided in a list — %or%","title":"Set the default value when not provided in a list — %or%","text":"Set default value provided list","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the default value when not provided in a list — %or%","text":"","code":"spec_val %or% default_val"},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the default value when not provided in a list — %or%","text":"spec_val specified value use (assuming provided) default_val value use default","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the default value when not provided in a list — %or%","text":"value dependent left-hand value provided, default value specified right hand side","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":null,"dir":"Reference","previous_headings":"","what":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"boards wall around outside rink constrain playing surface. boards typically ovular shape","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"","code":"hockey_boards( rink_length = 0, rink_width = 0, feature_radius = 0, feature_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"rink_length length rink rink_width width rink feature_radius radius corners boards feature_thickness thickness draw boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"data frame bounding coordinates boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"draws line defining faceoff circle center ice. line circular shape, usually dark blue color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"","code":"hockey_center_faceoff_circle(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"feature_radius radius center faceoff circle feature_thickness thickness line center faceoff circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"data frame containing bounding coordinates center faceoff circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":null,"dir":"Reference","previous_headings":"","what":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"center faceoff spot spot game begins. center lie directly center ice surface. radius passed key rink_params","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"","code":"hockey_center_faceoff_spot(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"feature_radius radius center faceoff spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"data frame containing bounding coordinates center faceoff spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"center line line divides ice surface half. center lie directly center ice surface. line thickness given 'major_line_thickness' major line ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"","code":"hockey_center_line( feature_thickness = 0, rink_width = 0, center_faceoff_spot_gap = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"feature_thickness thickness center line rink_width width rink","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"data frame bounding coordinates center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The defensive zone is the left ","title":"The defensive zone is the left ","text":"defensive zone left \"third\" rink TV view. area team defends attacking left right","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The defensive zone is the left ","text":"","code":"hockey_defensive_zone( rink_length = 0, rink_width = 0, feature_radius = 0, nzone_length = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The defensive zone is the left ","text":"rink_length length rink rink_width width rink feature_radius radius corners boards nzone_length length neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The defensive zone is the left ","text":"data frame bounding coordinates defensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"","code":"hockey_features_set_colors( plot_background = NULL, boards = \"#000000\", ozone_ice = \"#ffffff\", nzone_ice = \"#ffffff\", dzone_ice = \"#ffffff\", center_line = \"#c8102e\", zone_line = \"#0033a0\", goal_line = \"#c8102e\", restricted_trapezoid = \"#c8102e\", goal_crease_outline = \"#c8102e\", goal_crease_fill = \"#41b6e6\", referee_crease = \"#c8102e\", center_faceoff_spot = \"#0033a0\", faceoff_spot_ring = \"#c8102e\", faceoff_spot_stripe = \"#c8102e\", center_faceoff_circle = \"#0033a0\", odzone_faceoff_circle = \"#c8102e\", faceoff_line = \"#c8102e\", goal_frame = \"#c8102e\", goal_fill = \"#a5acaf4d\", team_a_bench = \"#ffffff\", team_b_bench = \"#ffffff\", team_a_penalty_box = \"#ffffff\", team_b_penalty_box = \"#ffffff\", off_ice_officials_box = \"#a5acaf\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"plot_background hexadecimal string representing color use feature boards hexadecimal string representing color use feature ozone_ice hexadecimal string representing color use feature nzone_ice hexadecimal string representing color use feature dzone_ice hexadecimal string representing color use feature center_line hexadecimal string representing color use feature zone_line hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature restricted_trapezoid hexadecimal string representing color use feature goal_crease_outline hexadecimal string representing color use feature goal_crease_fill hexadecimal string representing color use feature referee_crease hexadecimal string representing color use feature center_faceoff_spot hexadecimal string representing color use feature faceoff_spot_ring hexadecimal string representing color use feature faceoff_spot_stripe hexadecimal string representing color use feature center_faceoff_circle hexadecimal string representing color use feature odzone_faceoff_circle hexadecimal string representing color use feature faceoff_line hexadecimal string representing color use feature goal_frame hexadecimal string representing color use feature goal_fill hexadecimal string representing color use feature team_a_bench hexadecimal string representing color use feature team_b_bench hexadecimal string representing color use feature team_a_penalty_box hexadecimal string representing color use feature team_b_penalty_box hexadecimal string representing color use feature off_ice_officials_box hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"filling goal crease thickness given 'minor_line_thickness', refers crease's outline, minor line ice surface. goal crease's filling usually light color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"","code":"hockey_goal_crease_fill( feature_radius = 0, feature_thickness = 0, crease_style = \"\", crease_length = 0, crease_width = 0, notch_dist_x = 0, notch_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"feature_radius radius goal crease feature_thickness thickness line marking outline goal crease crease_style style goal crease crease_length length goal crease crease_width width goal crease notch_dist_x distance back edge goal line edge crease notch notch_width width notch goal crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"data frame containing bounding coordinates goal crease's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"outline goal crease thickness given 'minor_line_thickness', minor line ice surface, outline usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"","code":"hockey_goal_crease_outline( feature_radius = 0, feature_thickness = 0, crease_style = \"\", crease_length = 0, crease_width = 0, notch_dist_x = 0, notch_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"feature_radius radius goal crease feature_thickness thickness line marking outline goal crease crease_style style goal crease crease_length length goal crease crease_width width goal crease notch_dist_x distance back edge goal line edge crease notch notch_width width notch goal crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"data frame containing bounding coordinates goal crease's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"goal frame two thicknesses careful : outer diameter posts, outer diameter pipe back goal. frame goal usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"","code":"hockey_goal_frame( feature_radius = 0, goal_mouth_width = 0, goal_back_width = 0, goal_depth = 0, goal_post_diameter = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"feature_radius radius circular part goal frame goal_mouth_width width goal mouth goal_back_width width back frame goal goal_depth depth goal front goal line back goal frame goal_post_diameter diameter post goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"data frame containing bounding coordinates frame goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"goal frame two thicknesses careful : outer diameter posts, outer diameter pipe back goal. frame goal usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"","code":"hockey_goal_frame_fill( feature_radius = 0, goal_mouth_width = 0, goal_back_width = 0, goal_depth = 0, goal_post_diameter = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"feature_radius radius circular part goal frame goal_mouth_width width goal mouth goal_back_width width back frame goal goal_depth depth goal front goal line back goal frame goal_post_diameter diameter post goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"data frame containing bounding coordinates frame goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"draws right-side goal line (TV view), starting left edge. also accounts perfectly rectangular goal line user supplies value necessitates one. line rectangular shape rounded ends, usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"","code":"hockey_goal_line( rink_length = 0, rink_width = 0, feature_radius = 0, feature_thickness = 0, x_anchor = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"rink_length length rink rink_width width rink feature_radius radius corner rink feature_thickness thickness goal line x_anchor x coordinate used anchor point goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"data frame containing bounding coordinates goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"NOTE: requirement leagues, may omitted via \"has_trapezoid\" key rink_params passed geom_{league}","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"","code":"hockey_goaltenders_restricted_area( rink_length = 0, feature_thickness = 0, short_base_width = 0, long_base_width = 0, x_anchor = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"rink_length length rink feature_thickness thickness lines used draw goaltender's restricted area short_base_width width base nearest center line long_base_width width base nearest boards behind goal x_anchor x coordinate used anchor point goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"data frame containing bounding coordinates goaltender's restricted area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"draws goaltender's restricted area right side (TV view) ice surface. figure composed lines outline trapezoid shape, usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The neutral zone is the middle ","title":"The neutral zone is the middle ","text":"neutral zone middle \"third\" rink. area two zone (blue) lines. center neutral zone lie along line x = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The neutral zone is the middle ","text":"","code":"hockey_neutral_zone(rink_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The neutral zone is the middle ","text":"rink_width width rink feature_thickness length neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The neutral zone is the middle ","text":"data frame containing bounding coordinates neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":null,"dir":"Reference","previous_headings":"","what":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"function responsible creating outer ring, colored stripe running . Please see hockey_nodzone_faceoff_spot_stripe() information ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"","code":"hockey_nodzone_faceoff_spot_ring(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"feature_radius outer radius non-centered faceoff spot ring feature_thickness thickness non-centered faceoff spot ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"data frame containing bounding coordinates non-centered faceoff spot ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"non-centered faceoff spots faceoffs taken icing call start powerplay. differ center ice faceoff spot size, color, form. thickness given 'minor_line_thickness' minor lines ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":null,"dir":"Reference","previous_headings":"","what":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"function responsible creating inner stripe, colored outer ring around . Please see hockey_nodzone_faceoff_spot_ring() information ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"","code":"hockey_nodzone_faceoff_spot_stripe( feature_radius = 0, feature_thickness = 0, gap_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"feature_radius outer radius non-centered faceoff spot feature_thickness thickness non-centered faceoff spot ring gap_width width gap inner edge non-centered faceoff spot ring outer edge stripe","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"data frame containing bounding coordinates non-centered faceoff spot's stripe","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"non-centered faceoff spots faceoffs taken icing call start powerplay. differ center ice faceoff spot size, color, form. faceoff spot's stripe, 'feature_thickness' parameter thickness outer ring, 'minor_line_thickness'","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"non-centered faceoff circles faceoffs taken icing call start powerplay. differ center ice faceoff circle adjoining hash marks circles. also different color center ice faceoff circle, spot center varies size form. line thickness given 'minor_line_thickness' minor line ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"","code":"hockey_odzone_faceoff_circle( feature_radius = 0, feature_thickness = 0, hashmark_width = 0, hashmark_ext_spacing = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"feature_radius radius faceoff circle feature_thickness thickness line non-centered faceoff circle hashmark_width width hashmarks exterior non-centered faceoff circle hashmark_ext_spacing external spacing hashmarks' outer edges","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"data frame containing bounding coordinates non-centered faceoff circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"lines L-shaped, can thought two rectangles thickness given 'minor_line_thickness', usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"","code":"hockey_odzone_faceoff_lines( feature_thickness = 0, faceoff_line_dist_x = 0, faceoff_line_dist_y = 0, faceoff_line_length = 0, faceoff_line_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"feature_thickness thickness faceoff lines faceoff_line_dist_x distance center faceoff spot interior edge faceoff lines x direction faceoff_line_dist_y distance center faceoff spot interior edge faceoff lines y direction faceoff_line_length length faceoff lines edge nearest goal line edge nearest end boards faceoff_line_width width faceoff lines edge nearest center spot edge nearest side boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"data frame containing bounding coordinates offensive/defensive zone faceoff lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"thickness boards, located outside ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"","code":"hockey_off_ice_officials_box( feature_thickness = 0, officials_box_length = 0, officials_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"feature_thickness thickness outline -ice officials' box officials_box_length length -ice officials' box officials_box_depth depth -ice officials' box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"data frame containing bounding coordinates -ice officials' box's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The offensive zone is the right ","title":"The offensive zone is the right ","text":"offensive zone right \"third\" rink TV view. area team attacks try score goal attacking left right","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The offensive zone is the right ","text":"","code":"hockey_offensive_zone( rink_length = 0, rink_width = 0, feature_radius = 0, nzone_length = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The offensive zone is the right ","text":"rink_length length rink rink_width width rink feature_radius radius corners boards nzone_length length neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The offensive zone is the right ","text":"data frame bounding coordinates offensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"thickness boards, located outside ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"","code":"hockey_penalty_box_fill( feature_thickness = 0, penalty_box_length = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"feature_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"data frame containing bounding coordinates penalty box's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"thickness boards, located outside ice surface. penalty box's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"","code":"hockey_penalty_box_outline( feature_thickness = 0, penalty_box_length = 0, penalty_box_width = 0, penalty_box_separation = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"feature_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_separation separation two penalty boxes penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"data frame containing bounding coordinates penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"thickness boards, located outside ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"","code":"hockey_player_bench_area_fill( feature_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"feature_thickness thickness outline player bench area bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"data frame containing bounding coordinates player bench area's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"thickness boards, located outside ice surface. bench's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"","code":"hockey_player_bench_outline( feature_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"feature_thickness thickness outline player bench areas bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"data frame containing bounding coordinates player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":null,"dir":"Reference","previous_headings":"","what":"The referee's crease is a semi-circle on the ","title":"The referee's crease is a semi-circle on the ","text":"referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The referee's crease is a semi-circle on the ","text":"","code":"hockey_referee_crease(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The referee's crease is a semi-circle on the ","text":"feature_radius radius referee's crease feature_thickness thickness draw referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The referee's crease is a semi-circle on the ","text":"data frame bounding coordinates referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"zone lines lines separate neutral zone offensive defensive zones. line thickness given 'major_line_thickness' major line ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"","code":"hockey_zone_line(rink_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"rink_width width rink feature_thickness thickness zone line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"data frame containing bounding coordinates zone line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify if a passed color is a hexadecimal string — is_hex","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"Identify passed color hexadecimal string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"","code":"is_hex(col_str = \"\")"},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"col_str potentially-hexadecimal string check","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"boolean indicating string fact hexadecimal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":null,"dir":"Reference","previous_headings":"","what":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"fields, goal marking. circles mirror , center points used anchors","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"","code":"lacrosse_below_goal_marking(below_goal_marking_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"below_goal_marking_radius radius goal marking","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"data frame containing bounding coordinates goal marking","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":null,"dir":"Reference","previous_headings":"","what":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"boards wall around outside field constrain playing surface. boards either typically ovular shape, present field outdoors","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"","code":"lacrosse_boards( field_length = 0, field_width = 0, corner_radius = 0, boundary_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"field_length length field field_width width field corner_radius radius corners boards boundary_thickness thickness draw boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"data frame bounding coordinates boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"center circle play begins start game. located center field (present)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"","code":"lacrosse_center_circle(center_circle_radius = 0, center_circle_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"center_circle_radius outer radius center circle center_circle_thickness thickness center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"data frame containing bounding coordinates center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"center line divides field play two equal halves, generated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), lacrosse_neutral_zone(). line may stretch entire width field, parameter created instead","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"","code":"lacrosse_center_line(center_line_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"center_line_width width center line (distance y) line_thickness thickness center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"data frame containing bounding coordinates center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"change area box-shaped area front team benches substitutions occur. feature describes interior fill; outline controlled lacrosse_change_area_outline()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"","code":"lacrosse_change_area_fill(change_area_length = 0, change_area_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"change_area_length length change area's interior change_area_width distance boards change area extends playing surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"data frame containing bounding coordinates change area's interior fill","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"change area box-shaped area front team benches substitutions occur. feature describes outline; interior fill controlled lacrosse_change_area_fill()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"","code":"lacrosse_change_area_outline( change_area_length = 0, change_area_width = 0, feature_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"change_area_length length change area's interior change_area_width distance boards change area extends playing surface feature_thickness thickness outline box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"data frame containing bounding coordinates change area's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"defensive-area lines run parallel sidelines connected end line (see lacrosse_end_line()) restraining line (see lacrosse_restraining_line()) features present","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"","code":"lacrosse_defensive_area_line( defensive_area_line_length = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"defensive_area_line_length length defensive-area line length line_thickness thickness defensive area line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"data frame containing bounding coordinates defensive area lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"defensive zone TV-left area playing surface. many cases, correspond half field's length","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"","code":"lacrosse_defensive_zone( field_length = 0, field_width = 0, corner_radius = 0, nzone_length = 0, field_shape = \"rectangle\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"field_length interior length field field_width interior width field corner_radius radius corner (assuming field_shape = \"oval\"). Viable options \"rectangle\" \"oval\" nzone_length length neutral zone field_shape shape field, passed string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"data frame containing bounding coordinates defensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"end lines run width field, interior edge designating -bounds area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"","code":"lacrosse_end_line(field_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"field_width interior width field line_thickness thickness end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"data frame containing bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":null,"dir":"Reference","previous_headings":"","what":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"face-markers face-offs occur. may take one two forms: \"X\" shape circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"","code":"lacrosse_face_off_marker( shape = \"O\", feature_thickness = 0, side_length = 0, feature_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"shape one following strings (case-insensitive): \"X\" \"X\"-like shape. must specified feature_thickness parameter specify width bar \"X\", side_length parameter control length bar \"O\" circle shape. must specified feature_radius parameter determine size circle feature_thickness thickness single bar \"X\" shape side_length length single bar \"X\" shape feature_radius radius circular face-spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"data frame containing bounding coordinates face-spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"","code":"lacrosse_features_set_colors( plot_background = NULL, field_apron = \"#195f0c\", defensive_zone = \"#195f0c\", neutral_zone = \"#195f0c\", offensive_zone = \"#195f0c\", team_a_bench = \"#a5acaf4d\", team_b_bench = \"#a5acaf4d\", team_a_penalty_box = \"#a5acaf4d\", team_b_penalty_box = \"#a5acaf4d\", off_field_officials_box = \"#a5acaf\", boards = \"#ffa500\", end_line = \"#ffffff\", sideline = \"#ffffff\", center_line = \"#ffffff\", wing_line = \"#ffffff\", restraining_line = \"#ffffff\", defensive_area_line = \"#ffffff\", goal_line = \"#ffffff\", referee_crease = \"#ffffff\", referee_crease_fill = \"#195f0c\", goal_circle = \"#ffffff\", goal_circle_fill = \"#195f0c\", goal_arc = \"#ffffff\", goal_fan = \"#ffffff\", goal_fan_hash_mark = \"#ffffff\", goal_mouth_hash_mark = \"#ffffff\", goal_mouth = \"#ffffff\", below_goal_marking = \"#ffffff\", goal_frame = \"#ffa500\", goal_net = \"#a5acaf4d\", center_circle = \"#ffffff\", center_face_off_marker = \"#ffffff\", corner_face_off_marker = \"#ffffff\", change_area_outline = \"#ffffff\", change_area_fill = \"#195f0c\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"plot_background hexadecimal string representing color use feature field_apron hexadecimal string representing color use feature defensive_zone hexadecimal string representing color use feature neutral_zone hexadecimal string representing color use feature offensive_zone hexadecimal string representing color use feature team_a_bench hexadecimal string representing color use feature team_b_bench hexadecimal string representing color use feature team_a_penalty_box hexadecimal string representing color use feature team_b_penalty_box hexadecimal string representing color use feature off_field_officials_box hexadecimal string representing color use feature boards hexadecimal string representing color use feature end_line hexadecimal string representing color use feature sideline hexadecimal string representing color use feature center_line hexadecimal string representing color use feature wing_line hexadecimal string representing color use feature restraining_line hexadecimal string representing color use feature defensive_area_line hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature referee_crease hexadecimal string representing color use feature referee_crease_fill hexadecimal string representing color use feature goal_circle hexadecimal string representing color use feature goal_circle_fill hexadecimal string representing color use feature goal_arc hexadecimal string representing color use feature goal_fan hexadecimal string representing color use feature goal_fan_hash_mark hexadecimal string representing color use feature goal_mouth_hash_mark hexadecimal string representing color use feature goal_mouth hexadecimal string representing color use feature below_goal_marking hexadecimal string representing color use feature goal_frame hexadecimal string representing color use feature goal_net hexadecimal string representing color use feature center_circle hexadecimal string representing color use feature center_face_off_marker hexadecimal string representing color use feature corner_face_off_marker hexadecimal string representing color use feature change_area_outline hexadecimal string representing color use feature change_area_fill hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"Outdoor require field apron boundary lines visible","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"","code":"lacrosse_field_apron( field_length = 0, field_width = 0, field_apron_thickness = 0, field_shape = \"rectangle\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"field_length length field field_width width field field_apron_thickness thickness field apron field_shape shape field, passed string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"data frame bounding coordinates field apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":null,"dir":"Reference","previous_headings":"","what":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"arc around goal circle semi-circular area located around goal circle (see lacrosse_goal_circle()) may extend back end line, also may cut goal line extended. extension controlled via goal_arc_extension parameter. Note: hash marks generated via lacrosse_goal_fan_hash_mark()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"","code":"lacrosse_goal_arc( goal_arc_extension = 0, goal_arc_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"goal_arc_extension extension goal line towards end line goal_arc_radius outer radius goal arc, measured center goal line line_thickness thickness goal arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"data frame containing bounding coordinates goal arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"goal circle circular feature field houses goal line (see lacrosse_goal_line()) goal. Notably, fields surrounding arc /fan around goal area, feature circumscribes goal. features handled separately. feature may either full circle (e.g. 360 degrees), partial circle may greater half-circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"","code":"lacrosse_goal_circle( goal_circle_radius = 0, line_thickness = 0, goal_circle_full_360 = TRUE, goal_depth = 0, goal_depth_to_circle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"goal_circle_radius outer radius goal circle line_thickness thickness goal circle goal_circle_full_360 boolean indicating whether goal circle 360 degree circle goal_depth depth goal goal_depth_to_circle distance back tip goal outer radius goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"data frame containing bounding coordinates goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"feature area enclosed goal circle's outline. Please see lacrosse_goal_circle() information","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"","code":"lacrosse_goal_circle_fill( goal_circle_radius = 0, line_thickness = 0, goal_circle_full_360 = TRUE, goal_depth = 0, goal_depth_to_circle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"goal_circle_radius outer radius goal circle line_thickness thickness goal circle goal_circle_full_360 boolean indicating whether goal circle 360 degree circle goal_depth depth goal goal_depth_to_circle distance back tip goal outer radius goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"data frame containing bounding coordinates goal circle's enclosed area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"goal arc fan present fields (e.g. NCAAW) quarter-circle located around goal. anchor feature given center goal line, radius arc actually corresponds point goal circle (see lacrosse_goal_circle()) runs y = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"","code":"lacrosse_goal_fan( goal_fan_radius = 0, goal_circle_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"goal_fan_radius outer radius goal fan, measured center goal line outer edge goal fan goal_circle_radius radius goal circle line_thickness thickness goal fan line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"data frame containing bounding coordinates goal fan","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"hash marks around goal fan (see lacrosse_goal_fan()) drawn independently goal fan . just rectangles anchor points along circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"","code":"lacrosse_goal_fan_hash_mark( goal_fan_hash_mark_length = 0, line_thickness = 0, rotational_angle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"goal_fan_hash_mark_length length hash mark along goal fan line_thickness thickness hash mark along goal fan rotational_angle angle (degrees) hash mark rotated","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"data frame containing bounding coordinates hash mark along goal fan","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"goal frame posts ball must pass order score goal. usually triangular shape","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"","code":"lacrosse_goal_frame( goal_frame_opening_interior = 0, goal_post_thickness = 0, goal_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"goal_frame_opening_interior interior width goal frame's opening goal_post_thickness thickness goal post goal_depth outer depth goal anchored","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"data frame containing bounding coordinates goal frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"goal line front edge goal sits. spans entire interior dimension goal mouth. anchoring x coordinate center (e.g. half line's width side x anchor)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"","code":"lacrosse_goal_line( goal_frame_width = 0, line_thickness = 0, goal_line_full_diameter = FALSE, goal_circle_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"goal_frame_width interior width goal frame's opening line_thickness thickness goal line goal_line_full_diameter Whether goal line extend full diameter lacrosse_goal_circle() goal_circle_radius outer radius goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"data frame containing bounding coordinates goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"goal mouth similar goal fan, except plainly semi-circle located front goal fields appears. separation ends typically correspond diameter goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"","code":"lacrosse_goal_mouth( goal_mouth_radius = 0, line_thickness = 0, goal_mouth_semi_circle_separation = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"goal_mouth_radius outer radius goal mouth line_thickness thickness line marking goal mouth goal_mouth_semi_circle_separation separation ends flat part semi-circle goal mouth","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"data frame containing bounding coordinates goal mouth","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"goal mouth may hash mark extends towards midfield goal line extended. hash mark, anchored using outer edge","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"","code":"lacrosse_goal_mouth_hash_mark( goal_mouth_hash_mark_length = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"goal_mouth_hash_mark_length length goal line extended towards center field hash mark extends line_thickness thickness hash mark extending goal mouth","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"data frame containing bounding coordinates goal mouth's hash mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"goal net netting ball must hit order score point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"","code":"lacrosse_goal_net( goal_frame_opening_interior = 0, goal_post_thickness = 0, goal_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"goal_frame_opening_interior interior width goal frame's opening goal_post_thickness thickness goal post goal_depth outer depth goal anchored","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"data frame containing bounding coordinates goal net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"neutral zone corresponds area restraining lines. cases restraining lines, feature 0 length","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"","code":"lacrosse_neutral_zone(nzone_length = 0, field_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"nzone_length length neutral zone field_width width field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"data frame containing bounding coordinates neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"thickness boards, located outside field surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"","code":"lacrosse_off_field_officials_box( officials_box_thickness = 0, officials_box_length = 0, officials_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"officials_box_thickness thickness outline -field officials' box officials_box_length length -field officials' box officials_box_depth depth -field officials' box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"data frame containing bounding coordinates -field officials' box's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"offensive zone team tries score goal. TV-right area field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"","code":"lacrosse_offensive_zone( field_length = 0, field_width = 0, corner_radius = 0, nzone_length = 0, field_shape = \"rectangle\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"field_length interior length field field_width interior width field corner_radius radius corner (assuming field_shape = \"oval\"). Viable options \"rectangle\" \"oval\" nzone_length length neutral zone field_shape shape field, passed string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"data frame bounding coordinates offensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"thickness boards, located outside field surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"","code":"lacrosse_penalty_box_fill( penalty_box_outline_thickness = 0, penalty_box_length = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"penalty_box_outline_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"data frame containing bounding coordinates penalty box's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"thickness boards, located outside field surface. penalty box's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"","code":"lacrosse_penalty_box_outline( penalty_box_outline_thickness = 0, penalty_box_length = 0, penalty_box_width = 0, penalty_box_separation = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"penalty_box_outline_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_width width penalty box penalty_box_separation separation two penalty boxes penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"data frame containing bounding coordinates penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"thickness boards, located outside field surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"","code":"lacrosse_player_bench_area_fill( bench_area_outline_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"bench_area_outline_thickness thickness outline player bench area bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"data frame containing bounding coordinates player bench area's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"thickness boards, located outside field surface. bench's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"","code":"lacrosse_player_bench_outline( bench_area_outline_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"bench_area_outline_thickness thickness outline player bench areas bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"data frame containing bounding coordinates player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":null,"dir":"Reference","previous_headings":"","what":"The referee's crease is a semi-circle on the ","title":"The referee's crease is a semi-circle on the ","text":"referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line) referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The referee's crease is a semi-circle on the ","text":"","code":"lacrosse_referee_crease(referee_crease_radius = 0, line_thickness = 0) lacrosse_referee_crease(referee_crease_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The referee's crease is a semi-circle on the ","text":"referee_crease_radius radius referee's crease line_thickness thickness draw referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The referee's crease is a semi-circle on the ","text":"data frame bounding coordinates referee's crease data frame bounding coordinates referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The referee's crease is a semi-circle on the ","title":"The referee's crease is a semi-circle on the ","text":"referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line). feature corresponds section field encloses","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The referee's crease is a semi-circle on the ","text":"","code":"lacrosse_referee_crease_fill(referee_crease_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The referee's crease is a semi-circle on the ","text":"referee_crease_radius radius referee's crease line_thickness thickness draw referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The referee's crease is a semi-circle on the ","text":"data frame bounding coordinates referee's crease's enclosed area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"restraining line spans entire width field (present) connects defensive area lines (see lacrosse_defensive_area_line())","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"","code":"lacrosse_restraining_line(field_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"field_width width field line_thickness thickness restraining line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"data frame containing bounding coordinates restraining line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"sidelines run length field, interior edge designating -bounds area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"","code":"lacrosse_sideline(field_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"field_length interior length field line_thickness thickness sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"data frame containing bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"wing lines run parallel sidelines cross center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"","code":"lacrosse_wing_line(wing_line_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"wing_line_length length wing line line_thickness thickness wing line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"data frame containing bounding coordinates wing line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":null,"dir":"Reference","previous_headings":"","what":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"Load default parameters specified league. used debugging package","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"","code":"load_default_parameters( league = \"\", display_range = \"full\", court_updates = list(), field_updates = list(), pitch_updates = list(), rink_updates = list(), sheet_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, field_units = NULL, pitch_units = NULL, rink_units = NULL, sheet_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"league league load global environment display_range display range load global environment court_updates default court_updates load global environment. default empty list field_updates default field_updates load global environment. default empty list pitch_updates default pitch_updates load global environment. default empty list rink_updates default rink_updates load global environment. default empty list sheet_updates default sheet_updates load global environment. default empty list color_updates default color_updates load global environment. default empty list rotation default rotation load global environment. default 0 x_trans default translation x direction load global environment. default 0 y_trans default translation y direction load global environment. default 0 court_units default units court-like surface. default NULL field_units default units field-like surface. default NULL pitch_units default units pitch-like surface. default NULL rink_units default units rink-like surface. default NULL sheet_units default units sheet-like surface. default NULL xlims default limits plot use x direction. default NULL ylims default limits plot use y direction. default NULL","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"Nothing, environment variables set","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"Deploy quadratic formula given inputs , b, c satisfy equation (* (x ^ 2)) + bx + c = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"","code":"quadratic_formula(a, b, c)"},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"coefficient squared term b coefficient linear term c coefficient constant term","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"solutions equation","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":null,"dir":"Reference","previous_headings":"","what":"Perform a mathematical reflection of coordinates over a specified axis — reflect","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"Perform mathematical reflection coordinates specified axis","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"","code":"reflect(df, over_x = FALSE, over_y = TRUE)"},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"df data frame reflect. must x y columns over_x boolean indicating whether reflect x axis. Default: FALSE over_y boolean indicating whether reflect y axis. Default: TRUE","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"reflected data frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"","code":"reflect(data.frame(x = 1, y = 0)) #> x y #> 1 -1 0"},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":null,"dir":"Reference","previous_headings":"","what":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"Perform mathematical rotation (0, 0) coordinates. rotation given x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\* cos(theta)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"","code":"rotate_coords(df, angle = 90)"},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"df data frame rotate. must x y columns angle angle (degrees) rotate coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"rotated data frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"","code":"rotate_coords(data.frame(x = 0, y = 1)) #> x y #> 1 -1 6.123234e-17"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"","code":"soccer_center_circle(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"feature_radius outer radius center circle feature_thickness thickness center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"data frame containing bounding coordinates center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"center mark kickoffs half, well following goal, taken. radius given outside mark. feature located midfield","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"","code":"soccer_center_mark(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"feature_radius radius center mark pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"data frame containing bounding coordinates center mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":null,"dir":"Reference","previous_headings":"","what":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"","code":"soccer_corner_arc(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"feature_radius outer radius corner arc feature_thickness thickness corner arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"data frame containing bounding coordinates corner arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":null,"dir":"Reference","previous_headings":"","what":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"marks outside field play","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"","code":"soccer_corner_defensive_marks( feature_thickness = 0, is_touchline = FALSE, is_goal_line = FALSE, depth = 0, separation_from_line = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"feature_thickness thickness corner defensive marks is_touchline boolean indicating whether corner defensive marks along touchline is_goal_line boolean indicating whether corner defensive marks along goal line depth depth mark extends play separation_from_line distance back edge goal line interior edge corner defensive mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"data frame containing bounding coordinates corner defensive marks","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"","code":"soccer_features_set_colors( plot_background = NULL, offensive_half_pitch = \"#195f0c\", defensive_half_pitch = \"#195f0c\", pitch_apron = \"#195f0c\", touchline = \"#ffffff\", goal_line = \"#ffffff\", corner_arc = \"#ffffff\", halfway_line = \"#ffffff\", center_circle = \"#ffffff\", center_mark = \"#ffffff\", penalty_box = \"#ffffff\", goal_box = \"#ffffff\", penalty_mark = \"#ffffff\", corner_defensive_mark = \"#ffffff\", goal = \"#ffffff\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"plot_background hexadecimal string representing color use feature touchline hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature halfway_line hexadecimal string representing color use feature center_circle hexadecimal string representing color use feature center_mark hexadecimal string representing color use feature penalty_box hexadecimal string representing color use feature goal_box hexadecimal string representing color use feature penalty_mark hexadecimal string representing color use feature corner_defensive_mark hexadecimal string representing color use feature goal hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"","code":"soccer_goal(feature_thickness = 0, goal_width = 0, goal_depth = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"feature_thickness thickness goal goal_width interior width goal goal_depth depth goal protrudes away back edge goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"data frame containing bounding coordinates goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"","code":"soccer_goal_box( feature_thickness = 0, box_length = 0, goal_width = 0, goal_post_to_box_edge = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"feature_thickness thickness goal box box_length length goal box (goal line) goal_width interior width goal goal_post_to_box_edge distance interior goal post outer edge goal box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"data frame containing bounding coordinates goal box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"","code":"soccer_goal_line(pitch_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"pitch_width width pitch feature_thickness thickness goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"data frame containing bounding coordinates goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":null,"dir":"Reference","previous_headings":"","what":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"Half pitch located side halfway line (see soccer_halfway_line() information)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"","code":"soccer_half_pitch(pitch_length = 0, pitch_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"pitch_length length pitch pitch_width width pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"data frame containing bounding coordinates half pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"","code":"soccer_halfway_line(pitch_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"pitch_width width pitch feature_thickness thickness goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"data frame containing bounding coordinates halfway line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"draws half-box, include circular portion top box. dimensions given outside features","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"","code":"soccer_penalty_box( feature_radius = 0, feature_thickness = 0, box_length = 0, penalty_mark_dist = 0, goal_width = 0, goal_post_to_box_edge = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"feature_radius radius circle top penalty box feature_thickness thickness penalty box box_length length penalty box (goal line) penalty_mark_dist distance back edge goal line penalty mark goal_width interior width goal goal_post_to_box_edge distance interior goal post outer edge penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"data frame containing bounding coordinates penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"penalty mark center point arc penalty box, well penalty kick taken ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"","code":"soccer_penalty_mark(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"feature_radius radius penalty mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"data frame containing bounding coordinates penalty mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"Replicate spacing goal line/touchline nearest ad boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"","code":"soccer_pitch_apron( pitch_length = 0, pitch_width = 0, pitch_apron_touchline = 0, pitch_apron_goal_line = 0, goal_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"pitch_length length pitch pitch_width width pitch pitch_apron_touchline distance beyond outer edge touchline pitch's apron extend pitch_apron_goal_line distance beyond outer edge back goal pitch's apron extend goal_depth depth goal protrudes away back edge goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"data frame containing bounding coordinates pitch's apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"Allow goal line touchline clearly visible makes practical sense, grass outside -play area pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"","code":"soccer_touchline(pitch_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"pitch_length length pitch feature_thickness thickness touchline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"data frame containing bounding coordinates touchline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/surface_dimensions.html","id":null,"dir":"Reference","previous_headings":"","what":"surface_dimensions — surface_dimensions","title":"surface_dimensions — surface_dimensions","text":"list lists (JSON) associates league appropriate dimensions draw surface. data follows current dimensions specified rule books, can found rule book directory","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/surface_dimensions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"surface_dimensions — surface_dimensions","text":"set dimensions sport league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":null,"dir":"Reference","previous_headings":"","what":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"backcourt area behind serviceline court, contained within singles sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"","code":"tennis_backcourt(court_length = 0, serviceline_distance = 0, singles_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"court_length length court serviceline_distance distance net serviceline singles_width width singles court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"data frame containing bounding coordinates backcourt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":null,"dir":"Reference","previous_headings":"","what":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"baseline line behind player serve ball. spans entire width court, back edge denotes furthest boundary inside ball can land considered play","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"","code":"tennis_baseline(court_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"court_width width court feature_thickness thickness baseline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"data frame containing bounding coordinates baseline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"center mark identifies center point tennis_baseline(). line extend towards net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"","code":"tennis_center_mark(center_mark_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"center_mark_length length center mark measured back edge baseline feature_thickness thickness center mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"data frame containing bounding coordinates center mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":null,"dir":"Reference","previous_headings":"","what":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"line extends net back edge serviceline, centered line x = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"","code":"tennis_center_serviceline(center_serviceline_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"center_serviceline_length length center serviceline net back edge serviceline (see tennis_serviceline() information) feature_thickness thickness center serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"data frame containing bounding coordinates center serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"court apron referred backstop sidestop. areas entirely outside playing court, legal shots made considered play","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"","code":"tennis_court_apron( court_length = 0, court_width = 0, backstop_distance = 0, sidestop_distance = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"court_length length court court_width width court (usually doubles width court) backstop_distance distance back edge tennis_baseline() back boundary sidestop_distance distance outer edge tennis_sideline() side boundary","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"data frame containing bounding coordinates court apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":null,"dir":"Reference","previous_headings":"","what":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"doubles alley area singles doubles sideline. run entire length court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"","code":"tennis_doubles_alley(court_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"court_length length court feature_thickness thickness doubles alley (distance singles doubles sidelines)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"data frame containing bounding coordinates doubles alley","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"","code":"tennis_features_set_colors( plot_background = NULL, baseline = \"#ffffff\", singles_sideline = \"#ffffff\", doubles_sideline = \"#ffffff\", serviceline = \"#ffffff\", center_serviceline = \"#ffffff\", center_mark = \"#ffffff\", ad_court = \"#395d33\", deuce_court = \"#395d33\", backcourt = \"#395d33\", doubles_alley = \"#395d33\", court_apron = \"#395d33\", net = \"#d3d3d3\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"plot_background hexadecimal string representing color use feature baseline hexadecimal string representing color use feature singles_sideline hexadecimal string representing color use feature doubles_sideline hexadecimal string representing color use feature serviceline hexadecimal string representing color use feature center_serviceline hexadecimal string representing color use feature center_mark hexadecimal string representing color use feature ad_court hexadecimal string representing color use feature deuce_court hexadecimal string representing color use feature backcourt hexadecimal string representing color use feature doubles_alley hexadecimal string representing color use feature court_apron hexadecimal string representing color use feature net hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":null,"dir":"Reference","previous_headings":"","what":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"one half front court (either ad deuce court)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"","code":"tennis_frontcourt_half(serviceline_distance = 0, singles_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"serviceline_distance distance net serviceline singles_width width singles court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"data frame containing bounding coordinates one half frontcourt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":null,"dir":"Reference","previous_headings":"","what":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"net divides court two halves, run line x = 0 viewing court TV view","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"","code":"tennis_net(feature_thickness = 0, net_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"feature_thickness thickness net net_length length net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"data frame containing bounding coordinates net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":null,"dir":"Reference","previous_headings":"","what":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"line extends completely singles sidelines (extend doubles sidelines)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"","code":"tennis_serviceline(singles_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"singles_width width singles court feature_thickness thickness serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"data frame containing bounding coordinates serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"sideline runs entire length court, may four sidelines court (may refer either singles doubles sideline). Lines considered play, outer edge sideline lie along x = court_width / 2","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"","code":"tennis_sideline(court_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"court_length length court feature_thickness thickness sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"data frame containing bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"attack line runs sideline sideline separating court's backcourt (volleyball_backcourt()) front zone (volleyball_front_zone()). Players front row may attack either side line, players back row must begin attack backcourt side line. anchor point feature outer edge","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"","code":"volleyball_attack_line(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"court_width width court, measured exterior edges sidelines line_thickness thickness attack line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"data frame containing bounding box attack line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":null,"dir":"Reference","previous_headings":"","what":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"backcourt area attack line (see volleyball_attack_line()) end line (see volleyball_end_line()). Players playing back row rotation must take area attacking ball. considering entirety volleyball court divided thirds, either outer thirds court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"","code":"volleyball_backcourt( attack_line_edge_to_center_line = 0, court_length = 0, court_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"attack_line_edge_to_center_line distance edge furthest attack line center line running along x = 0 court_length length court, measured exterior edges end lines court_width width court, measured exterior edges sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"data frame containing bounding coordinates backcourt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"center line's axis runs along x = 0 viewing court TV view, dividing court two equal halves","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"","code":"volleyball_center_line(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"court_width width court, measured exterior edges sidelines line_thickness thickness center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"data frame containing bounding box center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"court apron similar basketball_court_apron() area outside court. may color interior court, necessarily. Unlike basketball_court_apron() however, boundary line thickness matter since lines considered -play therefore included court's length width. colored area inside free zone (see volleyball_free_zone()).","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"","code":"volleyball_court_apron( court_length = 0, court_width = 0, court_apron_end_line = 0, court_apron_sideline = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"court_length length court, measured exterior edges end lines court_width width court, measured exterior edges sidelines court_apron_end_line distance court apron extends beyond outer edge end line court_apron_sideline distance court apron extends beyond outer edge sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"data frame containing bounding coordinates court apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"lines court run full width court referred end lines, full width line considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"","code":"volleyball_end_line(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"court_width width court, measured exterior edges sidelines line_thickness thickness end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"data frame containing bounding box end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"","code":"volleyball_features_set_colors( plot_background = NULL, free_zone = \"#d2ab6f\", front_zone = \"#d2ab6f\", defensive_backcourt = \"#d2ab6f\", offensive_backcourt = \"#d2ab6f\", court_apron = \"#d2ab6f\", end_line = \"#000000\", sideline = \"#000000\", attack_line = \"#000000\", center_line = \"#000000\", service_zone_mark = \"#000000\", substitution_zone = \"#000000\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"plot_background hexadecimal string representing color use feature free_zone hexadecimal string representing color use feature front_zone hexadecimal string representing color use feature defensive_backcourt hexadecimal string representing color use feature offensive_backcourt hexadecimal string representing color use feature court_apron hexadecimal string representing color use feature end_line hexadecimal string representing color use feature sideline hexadecimal string representing color use feature attack_line hexadecimal string representing color use feature center_line hexadecimal string representing color use feature service_zone_mark hexadecimal string representing color use feature substitution_zone hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"free zone similar basketball_court_apron() area outside court. may color interior court, necessarily. Unlike basketball_court_apron() however, boundary line thickness matter since lines considered -play therefore included court's length width. volleyball_court_apron(), entire area outside court's lines, court apron corresponds colored apron inside free zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"","code":"volleyball_free_zone( court_length = 0, court_width = 0, free_zone_end_line = 0, free_zone_sideline = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"court_length length court, measured exterior edges end lines court_width width court, measured exterior edges sidelines free_zone_end_line distance free zone extends beyond outer edge end line free_zone_sideline distance free zone extends beyond outer edge sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"data frame containing bounding coordinates free zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"front zone area attack line (see volleyball_attack_line()) line running along x = 0. considering entirety volleyball court divided thirds, half middle third court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"","code":"volleyball_front_zone(attack_line_edge_to_center_line = 0, court_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"attack_line_edge_to_center_line distance edge furthest attack line center line running along x = 0 court_width width court, measured exterior edges sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"data frame containing bounding coordinates center zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"service zone marks lines beyond end lines denote legal serve must take place. appear four hash marks bounds court, contained within free zone (see volleyball_free_zone() reference)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"","code":"volleyball_service_zone_mark(service_zone_mark_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"service_zone_mark_length distance service zone mark extends away outer edge end line line_thickness thickness service zone marks","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"data frame containing bounding box service zone mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"lines court run full length court referred sidelines, full width line considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"","code":"volleyball_sideline(court_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"court_length length court, measured exterior edges end lines line_thickness thickness sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"data frame containing bounding box sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":null,"dir":"Reference","previous_headings":"","what":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"substitution zone typically marked dashed line extending attack lines (see volleyball_attack_line() ). creates single dash, dashes added plot accordingly","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"","code":"volleyball_substitution_zone_dash(dash_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"dash_length length dash draw line_thickness thickness substitution zone dashes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"data frame containing bounding box single dash substitution zone","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-222","dir":"Changelog","previous_headings":"","what":"sportyR 2.2.2","title":"sportyR 2.2.2","text":"Fixed #32 plot titles displaying correctly Updating documentation per CRAN notes r-devel","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-221","dir":"Changelog","previous_headings":"","what":"sportyR 2.2.1","title":"sportyR 2.2.1","text":"CRAN release: 2023-06-15 Faceting ggplot2 now works expected (#27, @mrcaseb) Fixed link vignette point POSIT, RStudio","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"patchesbug-fixes-2-2-0","dir":"Changelog","previous_headings":"","what":"Patches/Bug Fixes","title":"sportyR 2.2.0","text":"Fixed #24. Invalid league errors now explicit","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"changes-to-existing-sports-2-2-0","dir":"Changelog","previous_headings":"","what":"Changes to Existing Sports","title":"sportyR 2.2.0","text":"MLB MiLB bases now 18” default per 2023 rules change","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"lacrosse-2-2-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Lacrosse","title":"sportyR 2.2.0","text":"National Lacrosse League NCAA Men’s Lacrosse NCAA Women’s Lacrosse Premier Lacrosse League USA Men’s Lacrosse USA Women’s Lacrosse World Lacrosse","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"internal-changes-2-2-0","dir":"Changelog","previous_headings":"","what":"Internal Changes","title":"sportyR 2.2.0","text":"Re-aligned switch() statements condition cases matching indentation improve readability Updated syntax geom_football() avoid tidy syntax deprecation warning Added load_default_parameters() function faster debugging internally. function allows defaults particular geom_{sport}() function loaded set environment variables rather set one individually Updated data-raw/internal-datasets.R clear environment reload current version package upon sourcing debugging","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-210","dir":"Changelog","previous_headings":"","what":"sportyR 2.1.0","title":"sportyR 2.1.0","text":"CRAN release: 2022-10-31","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"patchesbug-fixes-2-1-0","dir":"Changelog","previous_headings":"","what":"Patches/Bug Fixes","title":"sportyR 2.1.0","text":"Fixed #14. Issue volleyball documentation Fixed #15. outline colors respected Added red zone border border outline football fields Changed default coloring football field border outline Fixed issue field border thickness plotting behind bench Fixed #18. Can now constrain plots display -bound playing area (plus sidelines) Corrected football field layering work better hex-alpha color specifications (layering colors previously caused issues)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"internal-changes-2-1-0","dir":"Changelog","previous_headings":"","what":"Internal Changes","title":"sportyR 2.1.0","text":"Renamed files use - (hyphen) instead _ (underscore) across package New function, is_hex(), checks value valid hexadecimal (relates #15) Animating Tracking Data vignette now uses images hosted GitHub avoid need render run time","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"volleyball-2-1-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Volleyball","title":"sportyR 2.1.0","text":"FIVB NCAA USA Volleyball","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"curling-2-1-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Curling","title":"sportyR 2.1.0","text":"Curling Canada","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-201","dir":"Changelog","previous_headings":"","what":"sportyR 2.0.1","title":"sportyR 2.0.1","text":"CRAN release: 2022-09-24","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"patchesbug-fixes-2-0-1","dir":"Changelog","previous_headings":"","what":"Patches/Bug Fixes","title":"sportyR 2.0.1","text":"Fixed #8. display ranges hockey rinks work expected Fixed #9. Yardage markers now move responsive x_trans y_trans Added gifski package Suggests-level dependency gifs vignettes may render properly","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"intenal-changes-2-0-1","dir":"Changelog","previous_headings":"","what":"Intenal Changes","title":"sportyR 2.0.1","text":"Changed logic curling ends drawn/placed curling sheet Adjusted xlims geom_hockey() include slightly neutral zone using display_range %% c(\"ozone\", \"dzone\") Updated licensing GPL >= 3 Changed website colors","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-200","dir":"Changelog","previous_headings":"","what":"sportyR 2.0.0","title":"sportyR 2.0.0","text":"CRAN release: 2022-08-15","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"internal-changes-2-0-0","dir":"Changelog","previous_headings":"","what":"Internal Changes","title":"sportyR 2.0.0","text":"Re-defined surfaces parameterized size features, rather defined individually file New internal data set (data-raw/surface_dimensions.json) maintain league dimensions Removal data-raw/sport_lookup.json data-raw/league_lookup.json files (replaced data-raw/surface_dimensions.json) Updated styling conventions match tidyverse style guide sole exception use explicit return() statements Updated file naming convention easier group feature files geom_{sport}() files Updated documentation","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"additional-capabilities-2-0-0","dir":"Changelog","previous_headings":"","what":"Additional Capabilities","title":"sportyR 2.0.0","text":"Introduction display_range parameter allow customized views plots (e.g. seeing red zone football field, rather entire field) Introduction {surface}_updates parameter allow customization surface starting base surface (e.g. geom_hockey(\"NHL\", surface_updates = list(rink_length = 400))) create regulation NHL ice rink twice long . allows package better handle edge cases support users bat less internal maintenance Introduction color_updates parameter allow colors features change easily explicitly internally code Introduction x_trans y_trans argument every surface adjust positioning origin","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"baseball-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Baseball","title":"sportyR 2.0.0","text":"MiLB Little League NCAA NFHS (high school) Pony","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"basketball-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Basketball","title":"sportyR 2.0.0","text":"NBA G League NFHS (high school)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"curling-new-supported-sport-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Curling (New Supported Sport)","title":"sportyR 2.0.0","text":"WCF (World Curling Federation)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"hockey-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Hockey","title":"sportyR 2.0.0","text":"AHL ECHL OHL QMJHL USHL","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"football-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Football","title":"sportyR 2.0.0","text":"NFHS 11-player NFHS 9-player NFHS 8-player NFHS 6-player","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"tennis-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Tennis","title":"sportyR 2.0.0","text":"ATP ITA USTA WTA","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"breaking-changes-and-justifications-for-breaks-2-0-0","dir":"Changelog","previous_headings":"","what":"Breaking Changes (and justifications for breaks)","title":"sportyR 2.0.0","text":"Removed full_surf rotation_dir arguments allow display_range flexible rotation arguments introduced. improved argument structure allow granular “zoom” plots regions interest, well adjusting coordinates appropriately match data sets Removed vdiffr tests becoming unmanageable didn’t scale well new leagues. Additionally, league change dimension requirements, case longer valid despite league’s plot requiring change. Instead, individual plotting functions checked well classes resulting plots","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-104","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.4","title":"sportyR 1.0.4","text":"Removed requirement include plot caption color (fixes #3) September 7, 2021, NWHL changed names PHF. name change now reflected package, NWHL still valid backwards compatible.","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-103","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.3","title":"sportyR 1.0.3","text":"Added tennis plotting capability Fixed issue NCAA football plot hash marks (initially typed 6, typed 60) Fixed minor bug soccer plots (changed rotation_dir = TRUE rotation_dir = \"ccw\") Fixed minor bug NCAA hockey plots plotting units ft (reordered geom_ncaa_hockey() code adjust units plotting) Restructured code tests/testthat/test-plot-functions.R closely resemble rest repository structure. Plots now tested sport rather plot-specific feature (e.g. units rotation) Fixed minor bug converting millimeters feet (originally specified 3048mm per foot, corrected 304.8mm per foot)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-102","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.2","title":"sportyR 1.0.2","text":"Added CFL plotting capability","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-101","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.1","title":"sportyR 1.0.1","text":"CRAN release: 2021-04-20 Introduced new testing infrastructure","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-100","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.0","title":"sportyR 1.0.0","text":"CRAN release: 2021-04-19 Initial release! Ability plot baseball, basketball ((W)NBA, NCAA, FIBA), football (NFL NCAA), hockey ((W)NHL, IIHF, NCAA), soccer (FIFA, MLS, NCAA, NWSL, Premier League) included, capability customize outputs specific colors.","code":""}] +[{"path":"https://sportyR.sportsdataverse.org/CODE-OF-CONDUCT.html","id":null,"dir":"","previous_headings":"","what":"Contributor Code of Conduct","title":"Contributor Code of Conduct","text":"contributors maintainers project, pledge respect people contribute reporting issues, posting feature requests, updating documentation, submitting pull requests patches, activities. committed making participation project harassment-free experience everyone, regardless level experience, gender, gender identity expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion. Examples unacceptable behavior participants include use sexual language imagery, derogatory comments personal attacks, trolling, public private harassment, insults, unprofessional conduct. Project maintainers right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct. Project maintainers follow Code Conduct may removed project team. Instances abusive, harassing, otherwise unacceptable behavior may reported opening issue, contacting emailing project lead (ross..drucker@gmail.com). Code Conduct adapted Contributor Covenant, version 1.0.0, available https://www.contributor-covenant.org/version/1/0/0/code--conduct.html","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to sportyR","title":"Contributing to sportyR","text":"First , thanks considering contributing sportyR! package, just like open source projects, can’t improve without contributions feedback users. sportyR labor love, one paid work . Please keep mind throughout contributions, responses bug fixes may take bit time work .","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"play-by-the-rules---code-of-conduct","dir":"","previous_headings":"","what":"Play by the Rules - Code of Conduct","title":"Contributing to sportyR","text":"Please note project released Contributor Code Conduct. participating project, ’re agreeing abide terms. sportyR’s League Office (see ) reserves right limit /exclude contributions violate Code Conduct appropriate.","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"getting-in-the-game---making-contributions","dir":"","previous_headings":"","what":"Getting In The Game - Making Contributions","title":"Contributing to sportyR","text":"’s many ways can contribute sportyR. want complete explanation can contribute (open source project, just one), check guide.","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"be-a-fan---love-the-package","dir":"","previous_headings":"Getting In The Game - Making Contributions","what":"Be A Fan - Love the Package","title":"Contributing to sportyR","text":"Think sportyR awesome? Want share awesome plots gifs made ? Let others discover telling person, tagging project Twitter, writing blog post experience ! ’re using sportyR academic context, please best cite package well.","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"scouting-reports---bugs-and-feature-suggestions","dir":"","previous_headings":"Getting In The Game - Making Contributions","what":"Scouting Reports - Bugs and Feature Suggestions","title":"Contributing to sportyR","text":"Like good sports organization, sportyR best scout solve problems become problems. Given tough test, problems sure arise. can overcome next match, however, making use good scouting (bug) reports. Please create Issue find something needs fixed. ’s good general guide follow creating one: Please double check README Issues pages sure problem hasn’t already solved. isn’t meant stop reporting problem, rather sure ’s new one can properly addressed. Title issue clear description ’re looking . Titling Issue “weird…” doesn’t give good idea ’re titling Issue “NCAA Football hashmarks place.” Even better can prefix/tag Issue bug feature-request Spend time creating detailed explanation, reproducible example, problem ’re . Without able understand issue, ’s even harder find ’s causing occur. best make sure code well-formatted easy others read: Make sure name variables something informative Use comments indicate believe problem code occurring include necessary code recreate problem Issue report can solved correctly","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"the-league-office-directory---contributor-status","dir":"","previous_headings":"Getting In The Game - Making Contributions","what":"The League Office Directory - Contributor Status","title":"Contributing to sportyR","text":"Want join sportyR’s team help shape package? Great! ’re always recruiting! ’s can join: League Office — contributing regularly, providing substantial upgrades package’s overall structure function, helping maintain package across board, ’ll considered membership sportyR’s League Office. order join League Office, must invited current member get approved majority members League Office become League Officer, list README, also list DESCRIPTION file role \"aut\" General Managers — Writing code extends sportyR’s sport-plotting reach developing new sports earn spot General Manager. Please list (alphabetical--sport order) README sport ’ve added. Note contributing new sport, ’ll considered General Manager sport. may asked assist sport-specific issues League Office unable provide clear answer Coaching Staffs — Patching bug already-existing sport means ’re eligible sport’s coaching staff. ’ve got eye game, ’s much appreciated! Coaches can list README well, similar General Managers listed Scout Team — fixing typo, making slight modification something already exists sportyR, regularly reporting issues package encounter (even helping others solve ), can join Scout Team. Thanks front lines package’s operation! Feel free list README Scout Team brief description role (“Typo Fixer” “Question Answerer” work great, creative ’d like)","code":""},{"path":"https://sportyR.sportsdataverse.org/CONTRIBUTING.html","id":"becoming-a-coachgeneral-manager---pull-request-process","dir":"","previous_headings":"","what":"Becoming a Coach/General Manager - Pull Request Process","title":"Contributing to sportyR","text":"become Cocah General Manager, submit Pull Request (PR) GitHub using process: Create branch git make changes wish see implemented Push branch GitHub open PR. PR titled way ’s obvious ’s overarching goal Discuss PR much detail possible. Provide links sources, clearly explain PR necessary can used. deviations conventions rest package clearly explained, deviation necessary Continue iterating request League Office determines addition good fit sportyR request checked following points: Motivation — Clearly concisely explain motivated PR. addresses particular issue, sure link Related Changes — submit PR, make sure PR addresses one issue. want fix multiple issues, please address separate PRs ’s clear change made PR. Please also sure PR doesn’t introduce new bugs break existing code Code Style File Naming — Please follow tidyverse styleguide, deviation explicit calls return() order return ’s needed function. Maintaining consistent styling facilitates easier current maintenance future development. Additionally, please keep consistent naming new files, especially adding new sport. Files contain new league named features-{sport}.R, new sport entirely, sure add corresponding geom-{new sport }.R file well. Dimensions maintained data-raw/surface-dimensions.json file, data-raw/internal_datasets.R sourced incorporate new changes. Please parameterize surface best abilities, ask questions! Documentation — introducing new code, please make sure document appropriately. Documentation comes two main forms: roxygen2 documentation functions write, comments throughout code explain code trying achieve. types documentation important! sure run devtools::document() sure documentation files properly created submitting, sure check spelling grammar. quick note internal/helper function documentation: please make sure omit files package build using @keywords internal roxygen2 documentation. reduces overall size package submitted CRAN, allows maximum package size 5MB Testing — sportyR relies upon extensive testing ensure package runs smoothly. currently 100% code coverage, PR ensure remains case. test coverage, sure covr package installed run following commands: show new code lacks sufficient coverage, please sure add tests tests/ repository make sure ’re covered! help creating tests, please reach League Office Although seems like lot work big hassle, League Office doesn’t expect perfection hand help needed.","code":"cov <- covr::package_coverage() covr::zero_coverage(cov)"},{"path":"https://sportyR.sportsdataverse.org/articles/animating-tracking-data.html","id":"the-data","dir":"Articles","previous_headings":"","what":"The Data","title":"Animating Tracking Data","text":"example, ’ll use play Week 15 2018 NFL season Chicago Bears Green Bay Packers. Data made available Big Data Bowl 2021 Kaggle competition. keep things easy, let’s specify colors team’s dots resulting GIF. ’ll make Bears orange Packers yellow. football also need dot seen; let’s make brown. First, let’s draw NFL field via geom_football(\"nfl\"). ’ll adjust origin lower left corner field, per notes coordinate system Kaggle page describing data. Image NFL field rendered sportyR Looks good! Now, let’s animate using gganimate. Gif tracking data Easy peasy. noted plotting-tracking-data vignette, works long geospatial data provided contains way identify order frames resulting GIF.","code":"# Load the play data example_nfl_play <- data.table::fread( glue::glue( \"https://raw.githubusercontent.com/sportsdataverse/sportyR/\", \"main/data-raw/example-pbp-data.csv\" ) ) # Convert to data frame example_nfl_play <- as.data.frame(example_nfl_play) # Prep data for plotting example_nfl_play[example_nfl_play[\"team\"] == \"home\", \"color\"] <- \"#c83803\" example_nfl_play[example_nfl_play[\"team\"] == \"away\", \"color\"] <- \"#ffb612\" example_nfl_play[example_nfl_play[\"team\"] == \"football\", \"color\"] <- \"#624a2e\" # Create the field nfl_field <- geom_football(\"nfl\", x_trans = 60, y_trans = 26.6667) # Display the field nfl_field # Add the points on the field play_anim <- nfl_field + geom_point( data = example_nfl_play, aes(x, y), color = example_nfl_play$color ) + transition_time(example_nfl_play$frameId) # Show the animation play_anim"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Plotting Tracking Data","text":"sportyR seeks make plotting geospatial tracking data straight-forward possible, allowing focus analysis visuals. ’ll demonstrate examples use package display “static” data, data shows snapshot time","code":""},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"the-data","dir":"Articles","previous_headings":"","what":"The Data","title":"Plotting Tracking Data","text":"example, ’ll using data provided Big Data Cup, publicly available. Specifically, data ’ll use demonstrate plot comes data provided Big Data Cup - 2021. Start reading data CSV file provided: Let’s explore dataset bit see () changes helpful ’d helpful change names columns easier work , ’ll change X Coordinate Y Coordinate x y, X Coordinate 2 Y Coordinate 2 x2 y2. ’ll use first game data , Minnesota Whitecaps Boston Pride. keep things easy ’ll focus first single-point data: shots. keep shots team side ice, need adjust coordinates shot. ’ve got keep shooter’s perspective towards net constant well, following appropriate transformation. positions data correctly, let’s move plotting","code":"# Read data from the Big Data Cup bdc_data <- data.table::fread( glue::glue( \"https://raw.githubusercontent.com/bigdatacup/Big-Data-Cup-2021\", \"/main/hackathon_nwhl.csv\" ) ) # Convert to data frame bdc_data <- as.data.frame(bdc_data) names(bdc_data) #> [1] \"game_date\" \"Home Team\" \"Away Team\" #> [4] \"Period\" \"Clock\" \"Home Team Skaters\" #> [7] \"Away Team Skaters\" \"Home Team Goals\" \"Away Team Goals\" #> [10] \"Team\" \"Player\" \"Event\" #> [13] \"X Coordinate\" \"Y Coordinate\" \"Detail 1\" #> [16] \"Detail 2\" \"Detail 3\" \"Detail 4\" #> [19] \"Player 2\" \"X Coordinate 2\" \"Y Coordinate 2\" # Change names of X Coordinate and Y Coordinate to x and y respectively names(bdc_data)[13:14] <- c(\"x\", \"y\") names(bdc_data)[20:21] <- c(\"x2\", \"y2\") # Preview what the data looks like knitr::kable(head(bdc_data)) # Subset to only be shots from the game on 2021-01-23 between the Minnesota # White Caps and Boston Pride bdc_shots <- bdc_data[(bdc_data$Event == \"Shot\") & (bdc_data$`Home Team` == \"Minnesota Whitecaps\") & (bdc_data$game_date == \"2021-01-23\"), ] # Separate shots by team whitecaps_shots <- bdc_shots[bdc_shots$Team == \"Minnesota Whitecaps\", ] pride_shots <- bdc_shots[bdc_shots$Team == \"Boston Pride\", ] # Correct the shot location whitecaps_shots[\"x\"] <- 200 - whitecaps_shots[\"x\"] whitecaps_shots[\"y\"] <- 85 - whitecaps_shots[\"y\"]"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"drawing-the-plot","dir":"Articles","previous_headings":"","what":"Drawing the Plot","title":"Plotting Tracking Data","text":"Since data pertains Premier Hockey Federation (PHF), ’ll start plotting drawing PHF-sized rink. ’ll use x_trans y_trans align data plot coordinates. encourage experiment data see works practice Now ’s left add data points plot! ggplot2 designed, straightforward.","code":"# Draw the rink phf_rink <- geom_hockey(\"phf\", x_trans = 100, y_trans = 42.5) # Display the rink here phf_rink"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"adding-the-data","dir":"Articles","previous_headings":"","what":"Adding the Data","title":"Plotting Tracking Data","text":"","code":"# Add the shots to the plot phf_rink + geom_point(data = whitecaps_shots, aes(x, y), color = \"#2251b8\") + geom_point(data = pride_shots, aes(x, y), color = \"#fec52e\")"},{"path":"https://sportyR.sportsdataverse.org/articles/plotting-tracking-data.html","id":"two-coordinate-data","dir":"Articles","previous_headings":"","what":"Two-Coordinate Data","title":"Plotting Tracking Data","text":"Pretend instead want look team’s passes executed game. also easy . Let’s take dataset , bdc_data, time subset look Boston’s passes game. ’ve already got rink plot , let’s just subset passing data, add plot: ! works geospatial data, sport (supported sportyR), league (supported sportyR). Give try, please reach ideas improvements!","code":"# Subset the data to be Boston's passes boston_passes <- bdc_data[(bdc_data$Event == \"Play\") & (bdc_data$Team == \"Boston Pride\") & (bdc_data$game_date == \"2021-01-23\"), ] # Plot passes with geom_segment() phf_rink + geom_segment( data = boston_passes, aes( x = x, y = y, xend = x2, yend = y2 ), lineend = \"round\", linejoin = \"round\", color = \"#ffcb05\" )"},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"installing-r-rstudio-and-sportyr","dir":"Articles","previous_headings":"","what":"Installing R, RStudio, and sportyR","title":"Getting Started","text":"(section courtesy Saiem Gilani. Give follow!) Head https://cran.r-project.org Select appropriate link operating system (Windows, Mac OS X, Linux) Windows - Select base download recent version Mac OS X - Select Latest Release, check make sure OS correct version. Look Binaries Legacy OS X Systems older release Linux - Select appropriate distro follow installation instructions Head RStudio.com Follow associated download installation instructions RStudio. Start peering RStudio IDE Cheatsheet. IDE integrated development environment. Windows users: recommend install Rtools. R package! “collection resources building packages R Microsoft Windows, building R ”. Go https://cran.r-project.org/bin/windows/Rtools/ follow directions installation. sportyR live CRAN, recent release can installed running: ’re development version package, try : library installed, sure load working environment.","code":"# Install released version from CRAN install.packages(\"sportyR\") # Install development version from GitHub devtools::install_github(\"sportsdataverse/sportyR\") # Required to use package library(sportyR)"},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"understanding-and-exploring-the-package","dir":"Articles","previous_headings":"","what":"Understanding and Exploring the Package","title":"Getting Started","text":"package really extension ggplot2, aim focus specifically sports playing surface. begs question: sports can plot using sportyR? ’re luck: kinds questions natively answered ’ve called cani_{question}() family functions. ’re designed answer questions like Can plot soccer pitch? Can plot PHF ice rink? ’s exact syntax can follow package answer questions. ’s example: ’ll highlight fact case-insensitive searches. Ask away heart’s content! ’s one cani_{question}() function ’ll highlight bit, first let’s start acting answers kinds questions.","code":"# Find out if you can plot a soccer pitch cani_plot_sport(\"soccer\") #> geom_soccer() can be used to plot for the following leagues: EPL, FIFA, MLS, NCAA, NWSL # See if a league comes pre-packaged with sportyR cani_plot_league(\"PHF\") #> A plot for PHF can be created via the geom_hockey() function"},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"the-geom_sport-functions","dir":"Articles","previous_headings":"","what":"The geom_{sport}() Functions","title":"Getting Started","text":"Now can ask questions package get answers, let’s start using information make plots. Say example ’re interested drawing regulation NBA basketball court. sportyR seeks make easy possible: Easy get started. ’s quick overview arguments (included geom_{sport}() functions): league: required parameter, custom viable value sport. quick note, using custom option require specify parameters surface ’re looking create. case-insensitive display_range: automatically “zooms” area plot ’re interested . Valid ranges vary sport, can found calling ?geom_{sport} reading display ranges x_trans y_trans: default, origin coordinate system always lies center plot. example, (0, 0) basketball court lies along division line line connects center basket. want shift origin (therefore entire plot), use x_trans y_trans {surface_type}_updates: list updates parameters define surface. ’ll demo use change hockey rink different vignette, ’ll call color_updates: list contains updates features’ colors plot. named feature , using snake_case specify names. get list color names can change, try running cani_color_league_features() desired league rotation: angle (degrees) ’d like rotate plot , +counterclockwise xlims ylims: limits ’d like put plot x y direction. overwrite anything set display_range parameter {surface}_units: data units different rule book league specifies units (e.g. ’ve got NHL data inches, rule book describes rink feet), change parameter match units ’ve got data . ’re welcome change units data well, provided convenience","code":"# Draw a regulation NBA basketball court geom_basketball(\"nba\")"},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/articles/sportyR.html","id":"author","dir":"Articles","previous_headings":"","what":"Author","title":"Getting Started","text":"Ross Drucker","code":""},{"path":"https://sportyR.sportsdataverse.org/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Ross Drucker. Author, maintainer.","code":""},{"path":"https://sportyR.sportsdataverse.org/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Drucker R (2024). sportyR: Plot Scaled 'ggplot' Representations Sports Playing Surfaces. R package version 2.2.2, https://github.com/sportsdataverse/sportyR, https://sportyr.sportsdataverse.org/.","code":"@Manual{, title = {sportyR: Plot Scaled 'ggplot' Representations of Sports Playing Surfaces}, author = {Ross Drucker}, year = {2024}, note = {R package version 2.2.2, https://github.com/sportsdataverse/sportyR}, url = {https://sportyr.sportsdataverse.org/}, }"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"sportyr-","dir":"","previous_headings":"","what":"Plot Scaled ggplot Representations of Sports Playing Surfaces","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"field sports analytics evolve, ’s growing need methods track visualize players throughout game. package aims make easy regardless sport needed plotted. repository contains code necessary draw scale versions playing surfaces visualize play--play data baseball, basketball, curling, football, hockey, soccer, tennis R. Python version package, click .","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"recent release sportyR available CRAN, can installed directly via: development version sportyR can installed GitHub : library installed, sure load working environment.","code":"# Install released version from CRAN install.packages(\"sportyR\") # Install development version from GitHub devtools::install_github(\"sportsdataverse/sportyR\") # Required to use package library(sportyR)"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"plotting-functions","dir":"","previous_headings":"","what":"Plotting Functions","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"plotting functions library named geom_{sport}(), take following arguments: league: league code sport. functions, default value. supplied league case-insensitive. Future iterations package may allow full league name supplied desired (e.g. league = 'National Basketball Associaton' instead league = 'NBA'), feature currently available. display_range: automatically “zooms” area plot ’re interested . Valid ranges vary sport, can found calling ?geom_{sport} reading display ranges x_trans y_trans: default, origin coordinate system always lies center plot. example, (0, 0) basketball court lies along division line line connects center basket. want shift origin (therefore entire plot), use x_trans y_trans {surface_type}_updates: list updates parameters define surface. ’ll demo use change hockey rink different vignette, ’ll call color_updates: list contains updates features’ colors plot. named feature , using snake_case specify names. get list color names can change, try running cani_color_league_features() desired league rotation: angle (degrees) ’d like rotate plot , +counterclockwise xlims ylims: limits ’d like put plot x y direction. overwrite anything set display_range parameter {surface}_units: data units different rule book league specifies units (e.g. ’ve got NHL data inches, rule book describes rink feet), change parameter match units ’ve got data . ’re welcome change units data well, provided convenience","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"tv-view","dir":"","previous_headings":"TV View and Display Ranges","what":"TV View","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"geom_{sport}() functions, default, draw surface can considered “TV view”, way surface typically displayed television broadcast. typically means action moves left right across screen (basketball game baskets left right end court). mentioned , possible change orientation rotation parameter geom_{sport}() function. exceptions : geom_baseball() displayed high-home view default, baseball coordinates typically +y axis extending back tip home plate towards center field geom_tennis() displayed court diagrammed perspective chair umpire","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"display-ranges","dir":"","previous_headings":"TV View and Display Ranges","what":"Display Ranges","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Related idea custom displays plot concept display_range parameter geom_{sport}() function. unique sport, globally supported across package. parameter allows specification designated region surface display. example, ’re trying limit analysis NFL data inside red zone, may want something similar following: Another use case make data ’re viewing easier see. Say wanted look curling data, cared stone positions house (path stones got ). might :","code":"# Display only the red zone of the football field geom_football(\"nfl\", display_range = \"red zone\") # Display only the house on a curling sheet geom_curling(\"wcf\", display_range = \"house\")"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"plot-units","dir":"","previous_headings":"","what":"Plot Units","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"plot function standardized unit measure plot created, standardized primary units specified respective rule books. follows (explanation parentheses): However, since data supplied may come various units measure, plots able generated data’s units. done via unit argument geom_{sport}(). features look visually identical, underlying coordinate grid change. Additionally, convert_units() function can called data frame convert data’s arguments plot’s. example, soccer data given yards, desirable plotted meters, calling convert_units(tracking_data, 'yd', 'm', conversion_columns = c('x', 'y')) convert x y coordinates yards meters. mentioned , geom_{sport}() family functions allow rotations surfaces via rotation argument. make easy, sportyR also allows rotation data frames’ coordinates long contain x y column via rotate_coords() function. Reflection also possible reflect().","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"surface-examples","dir":"","previous_headings":"","what":"Surface Examples","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"playing surfaces standard size, can rendered via call proper geom_{sport}() function like : ’s also possible plot partial surfaces rotated surfaces:","code":"# Draw a basic MLB infield plot geom_baseball(\"mlb\", display_range = \"infield\") # Create a 100m by 75m FIFA pitch geom_soccer( \"fifa\", pitch_updates = list( pitch_length = 100, pitch_width = 75 ) ) # Draw half of a rotated NBA court geom_basketball(\"nba\", display_range = \"offense\", rotation = 270)"},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"package released GPL 3.0 License.","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"league-office","dir":"","previous_headings":"Contributions","what":"League Office","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"package maintainers functional engineers Ross Drucker - sportyR Commissioner","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"general-managers","dir":"","previous_headings":"Contributions","what":"General Managers","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Contribute adding new sport become general manager. Current general managers (sports) : Ross Drucker - Baseball Ross Drucker - Basketball Ross Drucker - Curling Ross Drucker - Football Ross Drucker - Hockey Ross Drucker - Soccer Ross Drucker - Tennis Ross Drucker - Volleyball","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"coaching-staffs","dir":"","previous_headings":"Contributions","what":"Coaching Staffs","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Notice something sport already exists, isn’t quite right? Join sport’s coaching staff!","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"scout-team","dir":"","previous_headings":"Contributions","what":"Scout Team","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"regularly reporting issues, making slight modifications, fixing typos, just helping others navigate issues, ’re able join Scout Team!","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"acknowledgements","dir":"","previous_headings":"Contributions","what":"Acknowledgements","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"Much underling code structure sportyR, beginning v2.0.0, influenced Bucketless’s work hockey_rink package Python.","code":""},{"path":"https://sportyR.sportsdataverse.org/index.html","id":"sportyrtist","dir":"","previous_headings":"Contributions","what":"sportyRtist","title":"Plot Scaled ggplot Representations of Sports Playing Surfaces","text":"sportyR logo created Lindsey Kelso. Check Instagram online shop!","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":null,"dir":"Reference","previous_headings":"","what":"Add a surface's feature to a ggplot2 instance — add_feature","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"Add surface's feature ggplot2 instance","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"","code":"add_feature( g, x_anchor, y_anchor, feature_df, feature_color, feature_outline_color = \"#ffffff00\", reflect_x = FALSE, reflect_y = FALSE, x_trans = 0, y_trans = 0, rotation = 0, group = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"g ggplot2 instance onto feature added x_anchor anchor point along x axis feature y_anchor anchor point along y axis feature feature_df data frame containing points add feature feature_color hexadecimal string color feature added plot feature_outline_color hexadecimal string color outline feature added plot. default value \"#ffffff00\", white 0% alpha value. results outline added, usually desirable, may overwritten prevent \"seams\" appearing resulting plot reflect_x Whether reflect feature x axis reflect_y Whether reflect feature y axis group grouping pass along ggplot2::aes(). used speed NFL NCAA Football plotting functions","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/add_feature.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add a surface's feature to a ggplot2 instance — add_feature","text":"ggplot2 instance feature added ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":null,"dir":"Reference","previous_headings":"","what":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"One bases diamond, really base field. squares rotated 45 degrees","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"","code":"baseball_base( base_side_length = 0, adjust_x_left = FALSE, adjust_x_right = FALSE )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"base_side_length length side base adjust_x_left Whether base adjusted -x direction (e.g. third base) adjust_x_right Whether base adjusted +x direction (e.g. first base)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_base.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"One of the bases on the diamond, or really any base on the field. These are\nsquares that are rotated 45 degrees — baseball_base","text":"data frame comprises boundary base","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"batter's boxes field. batter must stand legally hit ball","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"","code":"baseball_batters_box( batters_box_length = 0, batters_box_width = 0, batters_box_y_adj = 0, batters_box_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"batters_box_length length batter's box (y direction) measured outside chalk lines batters_box_width width batter's box (x direction) measured outside chalk lines batters_box_y_adj shift center y direction batter's box moved properly align batters_box_thickness thickness chalk lines comprise batter's box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_batters_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The batter's boxes on the field. This is where a batter must stand to legally\nhit the ball — baseball_batters_box","text":"data frame batter's box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"catcher's box. catcher located defense, usually marked two white lines back line well. box may take various shapes, controlled catchers_box_shape parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"","code":"baseball_catchers_box( catchers_box_depth = 0, catchers_box_width = 0, batters_box_length = 0, batters_box_y_adj = 0, catchers_box_shape = \"rectangle\", catchers_box_thickness = 0, home_plate_circle_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"catchers_box_depth distance back tip home plate back edge catcher's box catchers_box_width distance outer edges catcher's box widest point batters_box_length length batter's box (y direction) measured outside chalk lines batters_box_y_adj shift center y direction batter's box moved properly align catchers_box_shape string representing shape catcher's box draw catchers_box_thickness thickness chalk lines comprise catcher's box home_plate_circle_radius radius circle around home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_catchers_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The catcher's box. This is where the catcher is located on defense, usually\nmarked by two white lines and a back line as well. The box may take various\nshapes, which are controlled by the catchers_box_shape parameter — baseball_catchers_box","text":"data frame containing bounding box catcher's box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"","code":"baseball_features_set_colors( plot_background = \"#395d33\", infield_dirt = \"#9b7653\", infield_grass = \"#395d33\", pitchers_mound = \"#9b7653\", base = \"#ffffff\", pitchers_plate = \"#ffffff\", batters_box = \"#ffffff\", catchers_box = \"#ffffff\", foul_line = \"#ffffff\", running_lane = \"#ffffff\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"plot_background hexadecimal string representing color use feature infield_dirt hexadecimal string representing color use feature infield_grass hexadecimal string representing color use feature pitchers_mound hexadecimal string representing color use feature base hexadecimal string representing color use feature pitchers_plate hexadecimal string representing color use feature batters_box hexadecimal string representing color use feature catchers_box hexadecimal string representing color use feature foul_line hexadecimal string representing color use feature running_lane hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — baseball_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"foul line. white lines extend back tip home plate (visibly batter's boxes) fair/foul pole outfield. Since ball line considered fair territory, outer edge baseline must lie fair territory (aka line y = +/- x)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"","code":"baseball_foul_line( is_line_1b = FALSE, line_distance = 0, batters_box_length = 0, batters_box_width = 0, batters_box_y_adj = 0, home_plate_side_to_batters_box = 0, foul_line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"is_line_1b Whether line first base line line_distance straight-line distance back tip home plate terminus line foul pole batters_box_length length batter's box (y direction) measured outside chalk lines batters_box_width width batter's box (x direction) measured outside chalk lines batters_box_y_adj shift center y direction batter's box moved properly align home_plate_side_to_batters_box distance outer edge batter's box inner edge home plate foul_line_thickness thickness chalk line comprise foul line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_foul_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The foul line. These are the white lines that extend from the back tip of\nhome plate (but not visibly through the batter's boxes) out to the fair/foul\npole in the outfield. Since a ball on the line is considered in fair\nterritory, the outer edge of the baseline must lie in fair territory (aka the\nline y = +/- x) — baseball_foul_line","text":"data frame containing foul line's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":null,"dir":"Reference","previous_headings":"","what":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"Home plate. pentagonal shape back tip located origin coordinate system. angled sides home plate intersect baselines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"","code":"baseball_home_plate(home_plate_edge_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"home_plate_edge_length length single edge home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_home_plate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Home plate. This is a pentagonal shape with its back tip located at the\norigin of the coordinate system. The angled sides of home plate intersect the\nbaselines — baseball_home_plate","text":"data frame contains boundary home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":null,"dir":"Reference","previous_headings":"","what":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"home plate circle may drawn shapes needed (example: Detroit's Comerica Park home plate shaped dirt area home plate \"circle\")","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"","code":"baseball_infield_dirt( home_plate_circle_radius = 0, foul_line_to_foul_grass = 0, pitchers_plate_distance = 0, infield_arc_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"home_plate_circle_radius radius circle around home plate foul_line_to_foul_grass distance outer edge foul line inner edge grass foul territory pitchers_plate_distance distance back tip home plate front edge pitcher's plate infield_arc_radius distance front edge pitcher's plate back infield dirt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_dirt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The dirt that comprises the infield. This includes the base paths, infield\narc, and home plate circle. — baseball_infield_dirt","text":"data frame comprises entirety infield dirt dirt circles around home plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":null,"dir":"Reference","previous_headings":"","what":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"dirt comprises infield grass. area inside lines drawn basepaths","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"","code":"baseball_infield_grass( home_plate_circle_radius = 0, foul_line_to_infield_grass = 0, baseline_distance = 0, base_anchor_to_infield_grass = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"home_plate_circle_radius radius circle around home plate foul_line_to_infield_grass distance outer edge foul line inner edge infield grass baseline_distance distance back tip home plate back corner either first third base along foul line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_infield_grass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The dirt that comprises the infield grass. This is the area inside the lines\ndrawn by the basepaths — baseball_infield_grass","text":"data frame comprises entirety infield grass","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":null,"dir":"Reference","previous_headings":"","what":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"pitcher's mound. pitcher's plate located, pitcher's plate necessarily centered pitcher's mound","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"","code":"baseball_pitchers_mound(pitchers_mound_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"pitchers_mound_radius radius pitcher's mound","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_mound.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The pitcher's mound. This is where the pitcher's plate is located, but the\npitcher's plate is not necessarily centered on the pitcher's mound — baseball_pitchers_mound","text":"data frame pitcher's mound's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":null,"dir":"Reference","previous_headings":"","what":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"pitcher's plate. pitcher must throw ball . usually long rectangle front edge anchor point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"","code":"baseball_pitchers_plate(pitchers_plate_length = 0, pitchers_plate_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"pitchers_plate_length length (x-direction) pitcher's plate pitchers_plate_width width (y-direction) pitcher's plate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_pitchers_plate.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The pitcher's plate. This is where the pitcher must throw the ball from. It's\nusually a long rectangle with its front edge as its anchor point — baseball_pitchers_plate","text":"data frame pitcher's plate's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":null,"dir":"Reference","previous_headings":"","what":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"measurements given \"looking line\" (e.g. measured observer standing behind home plate)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"","code":"baseball_running_lane( running_lane_depth = 0, running_lane_length = 0, running_lane_start_distance = 0, running_lane_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"running_lane_depth distance outer edge foul line outer edge running lane running_lane_length total distance running lane, first starts terminus near first base running_lane_start_distance distance back tip home plate running lane starts running_lane_thickness thickness chalk line comprises running lane","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/baseball_running_lane.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The running lane is entirely in foul territory. The depth should be measured\nfrom the foul-side edge of the baseline to the outer edge of the running lane\nmark — baseball_running_lane","text":"data frame containing running lane's bounding coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":null,"dir":"Reference","previous_headings":"","what":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"backboard backing onto basket ring (created basketball_basket_ring()) affixed. drawn rectangle court court drawn aerial view","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"","code":"basketball_backboard(backboard_width = 0, backboard_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"backboard_width width backboard viewed . x-direction dimension backboard taking point view free throw shooter backboard_thickness thickness backboard viewed ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_backboard.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The backboard is the backing onto which the basket ring (created by\nbasketball_basket_ring()) is affixed. This will be drawn as a\nrectangle on the court as the court is drawn from an aerial view — basketball_backboard","text":"data frame bounding box backboard","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":null,"dir":"Reference","previous_headings":"","what":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"explanation math used generate basket ring (connecting portion attaches ring backboard) walked using NBA dimensions, generalized code","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"","code":"basketball_basket_ring( basket_ring_connector_width = 0, backboard_face_to_ring_cent = 0, basket_ring_inner_radius = 0, basket_ring_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"basket_ring_connector_width width basket ring connector backboard_face_to_ring_cent far face backboard center basket ring's circle located basket_ring_inner_radius inner radius circular part basket ring basket_ring_thickness thickness basket ring's circular part","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"data frame boundary basket ring connector","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_basket_ring.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The hoop through which the ball must pass to score points for a team is\ncalled the basket ring — basketball_basket_ring","text":"connector width 7\", 3.5\" side x axis. ring radius 9\", arcsine measurements give angle point ring connector connect","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"center circle broken two parts: basketball_center_circle_outline(), fill (feature), court coloring inside inner edge circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"","code":"basketball_center_circle_fill(center_circle_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"center_circle_radius outer radius center circle line_thickness thickness line comprises center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is broken into two parts: the\nbasketball_center_circle_outline(), and the fill (this feature), which is\nthe court coloring inside of the inner edge of this circle — basketball_center_circle_fill","text":"data frame boundary center circle. interior coordinates correspond filled section","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"center circle broken two parts: outline (feature) fill, court coloring inside inner edge circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"","code":"basketball_center_circle_outline(center_circle_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"center_circle_radius outer radius center circle line_thickness thickness line comprises center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_center_circle_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is broken into two parts: the outline (this feature) and\nthe fill, which is the court coloring inside of the inner edge of this circle — basketball_center_circle_outline","text":"data frame boundary center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"apron court colored boundary around exterior courts. colored boundary exists, take color court floor","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"","code":"basketball_court_apron( court_length = 0, court_width = 0, court_apron_endline = 0, court_apron_sideline = 0, court_apron_to_boundary = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"court_length length court court_width width court court_apron_endline thickness court's apron beyond endline court_apron_sideline thickness court's apron beyond sideline court_apron_to_boundary distance inner edge court apron outer edge court's boundary line (sideline endline spaced ) line_thickness thickness endline sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_court_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The apron of the court is the colored boundary around the exterior of some\ncourts. If no such colored boundary exists, this should take the same color\nas the court floor — basketball_court_apron","text":"data frame bounding coordinates court apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"division line divides court two halves, sometimes referred time line half-court line. center line goes y axis, half line lying team's offensive half court half defensive half court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"","code":"basketball_division_line( court_width = 0, line_thickness = 0, division_line_extension = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"court_width width court line_thickness thickness division line division_line_extension distance division line extends beyond sideline. may omitted value 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_division_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The division line divides the court into two halves, and is sometimes\nreferred to as the time line or half-court line. The center of this line goes\nthrough the y axis, with half of the line lying in a team's offensive half\ncourt and the other half in their defensive half court — basketball_division_line","text":"data frame bounding box division line court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":null,"dir":"Reference","previous_headings":"","what":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"endline basketball court, also called baseline, located beyond basket. cases endline court apron, endline still generated color set equal court apron's color (see basketball_court_apron() information court apron)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"","code":"basketball_endline(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"court_width width court line_thickness thickness endline sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_endline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The endline on a basketball court, also called the baseline, is located\nbeyond each basket. In cases where the endline is the court apron, the\nendline should still be generated and its color should be set equal to the\ncourt apron's color (see basketball_court_apron() for more information on\nthe court apron) — basketball_endline","text":"data frame bounding coordinates endline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"","code":"basketball_features_set_colors( plot_background = NULL, defensive_half_court = \"#d2ab6f\", offensive_half_court = \"#d2ab6f\", court_apron = \"#d2ab6f\", center_circle_outline = \"#000000\", center_circle_fill = \"#d2ab6f\", division_line = \"#000000\", endline = \"#000000\", sideline = \"#000000\", two_point_range = \"#d2ab6f\", three_point_line = \"#000000\", painted_area = \"#d2ab6f\", lane_boundary = \"#000000\", free_throw_circle_outline = \"#000000\", free_throw_circle_fill = \"#d2ab6f\", free_throw_circle_dash = \"#000000\", lane_space_mark = \"#000000\", inbounding_line = \"#000000\", substitution_line = \"#000000\", baseline_lower_defensive_box = \"#000000\", lane_lower_defensive_box = \"#000000\", team_bench_line = \"#000000\", restricted_arc = \"#000000\", backboard = \"#000000\", basket_ring = \"#f55b33\", net = \"#ffffff\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"plot_background hexadecimal string representing color use feature defensive_half_court hexadecimal string representing color use feature offensive_half_court hexadecimal string representing color use feature court_apron hexadecimal string representing color use feature center_circle_outline hexadecimal string representing color use feature center_circle_fill hexadecimal string representing color use feature division_line hexadecimal string representing color use feature endline hexadecimal string representing color use feature sideline hexadecimal string representing color use feature two_point_range hexadecimal string representing color use feature three_point_line hexadecimal string representing color use feature painted_area hexadecimal string representing color use feature lane_boundary hexadecimal string representing color use feature free_throw_circle_outline hexadecimal string representing color use feature free_throw_circle_fill hexadecimal string representing color use feature free_throw_circle_dash hexadecimal string representing color use feature lane_space_mark hexadecimal string representing color use feature inbounding_line hexadecimal string representing color use feature substitution_line hexadecimal string representing color use feature baseline_lower_defensive_box hexadecimal string representing color use feature lane_lower_defensive_box hexadecimal string representing color use feature team_bench_line hexadecimal string representing color use feature restricted_arc hexadecimal string representing color use feature backboard hexadecimal string representing color use feature basket_ring hexadecimal string representing color use feature net hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — basketball_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"outline free throw circle. interior filling area created via basketball_free_throw_circle_fill()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"","code":"basketball_free_throw_circle( overhang = 0, free_throw_circle_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"overhang arc length free throw circle hangs past free throw line free_throw_circle_radius radius free throw circle line_thickness thickness free throw line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The outline of the free throw circle. The interior filling area is created\nvia basketball_free_throw_circle_fill() — basketball_free_throw_circle","text":"data frame bounding coordinates free throw circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":null,"dir":"Reference","previous_headings":"","what":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"courts, series dashes comprise bottom half free throw circle (e.g. half closer basket). function generates single dash","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"","code":"basketball_free_throw_circle_dash( feature_radius = 0, line_thickness = 0, start_angle = 0, end_angle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"feature_radius radius free throw circle line_thickness thickness dash start_angle angle, radians / pi, dash start end_angle angle, radians / pi, dash end","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_dash.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"On some courts, there are a series of dashes that comprise the bottom half of\nthe free throw circle (e.g. the half closer to the basket). This function\ngenerates a single dash — basketball_free_throw_circle_dash","text":"data frame containing bounding coordinates dash free throw circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"filled-section free throw circle. circle area free throw shooter stands attempting free throw. outline area created separately via basketball_free_throw_circle()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"","code":"basketball_free_throw_circle_fill( free_throw_circle_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"free_throw_circle_radius outer radius free throw circle, measured center free throw line line_thickness thickness outline free throw circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_circle_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The filled-in section of the free throw circle. The circle is the area where\na free throw shooter stands when attempting the free throw. The outline of\nthis area will be created separately via\nbasketball_free_throw_circle() — basketball_free_throw_circle_fill","text":"data frame containing bounding coordinates free throw circle's semi-circular filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"NOTE: include lane space markings (blocks), created via basketball_lane_space_mark().","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"","code":"basketball_free_throw_lane_boundary( lane_length = 0, lane_width = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"lane_length length free throw lane lane_width width free throw line_thickness thickness free throw lane boundary","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_free_throw_lane_boundary.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines providing the boundary to the free throw lane. When a player is\nshooting a free throw, all non-shooting players must be outside of this\nboundary — basketball_free_throw_lane_boundary","text":"data frame bounding coordinates free throw lane boundary","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":null,"dir":"Reference","previous_headings":"","what":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"half court spans inner edge baseline center division line, serves base layer court plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"","code":"basketball_half_court(court_length = 0, court_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"court_length length court court_width width court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_half_court.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Each half court spans from the inner edge of the baseline to the center of\nthe division line, and serves as the base layer of the court plot — basketball_half_court","text":"data frame bounding box half basketball court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"inbounding line ball inbounded sideline necessary. Lines drawn top court drawn top-direction, lines bottom court drawn bottom-direction","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"","code":"basketball_inbounding_line( line_thickness = 0, in_play_ext = 0, out_of_bounds_ext = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"line_thickness thickness inbounding line in_play_ext extension inbounding line court out_of_bounds_ext extension inbounding line away court drawn_direction string indicating way, un-rotated plot, line drawn looking plot TV View","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_inbounding_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The inbounding line is where the ball is inbounded on the sideline when\nnecessary. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_inbounding_line","text":"data frame containing bounding box inbounding line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"lane space marks, also known blocks, denote non-shooting players stand free throws. Players may cross lines ball touches rim shot attempt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"","code":"basketball_lane_space_mark(feature_thickness = 0, mark_depth = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"feature_thickness thickness lane space mark (distance x direction \"TV View\") mark_depth distance exterior edge free throw lane boundary lane space mark extends towards sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lane_space_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lane space marks, also known as the blocks, denote where non-shooting\nplayers stand during free throws. Players may not cross these lines before\nthe ball touches the rim on the shot attempt — basketball_lane_space_mark","text":"data frame containing bounding box lane space mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"lower defensive box imaginary box court extending lines baseline lines inside painted area. box helps determine block/charge call take place, offensive player entitled move outside (subsequently enter) box without contact","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"","code":"basketball_lower_defensive_box_mark( drawn_direction = \"\", extension = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"drawn_direction string indicating way draw lower defensive box mark extension amount lower defensive box mark extends drawn direction line_thickness thickness line representing lower defensive box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_lower_defensive_box_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lower defensive box is an imaginary box on the court extending from the\nlines on the baseline to the lines inside the painted area. This box helps\ndetermine when a block/charge call should take place, as an offensive player\nis entitled to move outside of (and subsequently enter) this box without\ncontact — basketball_lower_defensive_box_mark","text":"data frame bounding box lower defensive box marking","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":null,"dir":"Reference","previous_headings":"","what":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"make basket ring easier identify, nets also drawn onto plot. typically white color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"","code":"basketball_net(basket_ring_inner_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"basket_ring_inner_radius radius interior basket ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_net.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"To make the basket ring easier to identify, the nets will also be drawn onto\nthe plot. They will typically be white in color — basketball_net","text":"data frame net's circular outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"painted area may different color rest two point range area (see basketball_two_point_range() information two-point range), may also color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"","code":"basketball_painted_area( lane_length = 0, lane_width = 0, paint_margin = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"lane_length length free throw lane lane_width width free throw paint_margin distance painted area lane free throw lane boundary lines line_thickness thickness line free throw lane boundary line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_painted_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The painted area is the area contained by the free throw lane (see\nbasketball_free_throw_lane_boundary() for more information on the free\nthrow lane) — basketball_painted_area","text":"data frame bounding coordinates free throw lane's painted area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":null,"dir":"Reference","previous_headings":"","what":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"arc located free-throw lane called restricted arc. interior radius specified feature.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"","code":"basketball_restricted_arc( feature_radius = 0, line_thickness = 0, backboard_to_center_of_basket = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"feature_radius interior radius restricted arc line_thickness thickness restricted arc line backboard_to_center_of_basket distance backboard center basket","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_restricted_arc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The arc located in the free-throw lane is called the restricted arc. The\ninterior radius should be specified for this feature. — basketball_restricted_arc","text":"data frame containing bounding coordinates restricted arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"sideline basketball court run full length court, typically team bench areas substitution areas exterior. cases sideline court apron, sideline still generated color set equal court apron's color (see basketball_court_apron() information court apron)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"","code":"basketball_sideline(court_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"court_length length court line_thickness thickness endline sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sideline on a basketball court run the full length of the court,\ntypically with the team bench areas and substitution areas on their exterior.\nIn cases where the sideline is the court apron, the sideline should still be\ngenerated and its color should be set equal to the court apron's color (see\nbasketball_court_apron() for more information on the court apron) — basketball_sideline","text":"data frame bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"substitution line players checking game wait stoppage. Lines drawn top court drawn top-direction, lines bottom court drawn bottom-direction","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"","code":"basketball_substitution_line( line_thickness = 0, substitution_line_width = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"line_thickness thickness substitution line substitution_line_width width substitution line, top bottom viewing plot TV view drawn_direction string indicating way, un-rotated plot, line drawn looking plot TV View","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_substitution_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The substitution line is where players checking into the game wait for a\nstoppage. Lines drawn on the top of the court should be drawn in a top-down\ndirection, and lines on the bottom of the court should be drawn in the\nbottom-up direction — basketball_substitution_line","text":"data frame containing bounding coordinates substitution line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":null,"dir":"Reference","previous_headings":"","what":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"Players game must stay within team bench lines unless moving substitution area (see basketball_substitution_line() class)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"","code":"basketball_team_bench_line( line_thickness = 0, extension = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"line_thickness thickness team bench line extension extension team bench line court drawn_direction string indicating way, un-rotated plot, line drawn looking plot TV View","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_team_bench_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Players not in the game must stay within the team bench lines unless moving\nto the substitution area (see basketball_substitution_line() class) — basketball_team_bench_line","text":"data frame containing bounding coordinates team bench line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":null,"dir":"Reference","previous_headings":"","what":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"Start getting distance center basket corner three-point shot. referred start_y","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"","code":"basketball_three_point_line( basket_center_to_baseline = 0, basket_center_to_corner_three = 0, line_thickness = 0, three_point_line_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"basket_center_to_baseline distance center basket ring inner edge baseline basket_center_to_corner_three distance center basket ring outer edge three-point line corner court's specified units line_thickness thickness three-point line three_point_line_radius outer radius arc portion three-point line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"data frame bounding coordinates three-point line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_three_point_line.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"An arc on the court, behind which any made basket counts as three points and\nin front of which, any made basket will count as two points (see\nbasketball_two_point_range() for more information). — basketball_three_point_line","text":"Next, get starting angle trace two-point range. Taking distance start_y y coordinate, radius arc three-point line radius, sine starting angle given start_y / three_point_arc_radius TV-right angle start arc drawn , starting ending angles need adjusted relative 1 radian (arc opens right, like ( character) starting angle therefore given 1 - angle, ending angle 1 + angle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":null,"dir":"Reference","previous_headings":"","what":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"also noted corresponds strictly area contained three-point line, interior angle needed. utilizing corner-three distance outer edge work generally, issue may arise z-order feature's plotting characteristic changed greater three-point line . happen, interior edge therefore used ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"","code":"basketball_two_point_range( basket_center_to_baseline = 0, basket_center_to_corner_three = 0, line_thickness = 0, two_point_range_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"basket_center_to_baseline distance center basket ring inner edge baseline basket_center_to_corner_three distance center basket ring outer edge three-point line corner court's specified units line_thickness thickness three-point line two_point_range_radius radius arc portion three-point line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"data frame bounding coordinates two-point range","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/basketball_two_point_range.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"If a court has a three-point line (see basketball_three_point_line()), then\nany made basket (not including free throws) made from inside of the arc are\nworth two points. The area inside of this arc is therefore referred to as two\npoint range, which this feature draws. This feature is enclosed by the\nthree-point line's outer edge and the baseline's inner edge — basketball_two_point_range","text":"Start getting distance center basket corner three-point shot. referred start_y Next, get starting angle trace two-point range. Taking distance start_y y coordinate, (outer) radius arc three-point line radius, sine starting angle given start_y / {three_point_arc_radius - three_point_line_thickness} TV-right angle start arc drawn , starting ending angles need adjusted relative 1 radian (arc opens right, like ( character) starting angle therefore given 1 - angle, ending angle 1 + angle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":null,"dir":"Reference","previous_headings":"","what":"Check to see what features of a surface can be colored — cani_color_league_features","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"Check see features surface can colored","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"","code":"cani_color_league_features(league_code, sport_name = NULL)"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"league_code case-insensitive league code plotted sport_name name sport use event league_code supplied one sport associated . Default: NULL","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"Nothing, message sent console","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_color_league_features.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check to see what features of a surface can be colored — cani_color_league_features","text":"","code":"cani_color_league_features(\"NCAA\", \"basketball\") #> Here are the viable plotting features to color for NCAA basketball: #> #> plot_background #> defensive_half_court #> offensive_half_court #> court_apron #> center_circle_outline #> center_circle_fill #> division_line #> endline #> sideline #> two_point_range #> three_point_line #> painted_area #> lane_boundary #> free_throw_circle_outline #> free_throw_circle_fill #> free_throw_circle_dash #> lane_space_mark #> inbounding_line #> substitution_line #> baseline_lower_defensive_box #> lane_lower_defensive_box #> team_bench_line #> restricted_arc #> backboard #> basket_ring #> net"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":null,"dir":"Reference","previous_headings":"","what":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"Check see league can plotted, alert function(s) league work ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"","code":"cani_plot_league(league_code)"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"league_code case-insensitive league code plotted","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"Nothing, message sent console","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_league.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check to see if a league can be plotted, and alert as to which function(s)\nthat league will work for — cani_plot_league","text":"","code":"cani_plot_league(\"MLB\") #> A plot for MLB can be created via the geom_baseball() function"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":null,"dir":"Reference","previous_headings":"","what":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"Check see sport can plotted, alert league(s) plottable sport","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"","code":"cani_plot_sport(sport_code)"},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"sport_code case-insensitive sport name","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"Nothing, message sent console","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/cani_plot_sport.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check to see if a sport can be plotted, and alert as to which league(s) are\nplottable for the sport — cani_plot_sport","text":"","code":"cani_plot_sport(\"basketball\") #> geom_basketball() can be used to plot for the following leagues: FIBA, NBA, NBA G LEAGUE, NCAA, NFHS, WNBA"},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert all units, regardless of starting and ending units — convert_units","title":"Convert all units, regardless of starting and ending units — convert_units","text":"Convert units, regardless starting ending units","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert all units, regardless of starting and ending units — convert_units","text":"","code":"convert_units(meas, from_unit, to_unit, conversion_columns = NULL)"},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert all units, regardless of starting and ending units — convert_units","text":"meas measurement unit length from_unit string containing original unit measure converted to_unit string containing ending unit measure conversion_columns vector containing columns convert meas type data.frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert all units, regardless of starting and ending units — convert_units","text":"measurement converted units","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/convert_units.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert all units, regardless of starting and ending units — convert_units","text":"","code":"convert_units(1, \"in\", \"cm\") #> [1] 2.54 convert_units(100, \"cm\", \"m\") #> [1] 1"},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"Create set x y coordinates form circle (arc circle)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"","code":"create_circle(center = c(0, 0), npoints = 1000, r = 1, start = 0, end = 2)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"center (x, y) coordinates center circle. Default: (0, 0) npoints number points create circle. also length resulting data frame. Default: 1000 r radius circle UNITS PLOT. default unit feet. Default: 1 (unit circle) start angle (radians, divided pi) start drawing circle, zero runs along +x axis. Default: 0 end angle (radians, divided pi) stop drawing circle, zero runs along +x axis. Default: 2","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a circle (or the\narc of a circle) — create_circle","text":"data frame containing points needed draw specified circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"Create set x y coordinates form diamond. function wrapper create_rectangle() ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"","code":"create_diamond(height, width, center = c(0, 0))"},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"height vertical height diamond width horizontal width diamond center center coordinates diamond","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_diamond.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a diamond. This\nfunction is a wrapper on create_rectangle() above — create_diamond","text":"data frame containing points needed draw specified diamond","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":null,"dir":"Reference","previous_headings":"","what":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"Create base ggplot2 instance correct theme elements","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"","code":"create_plot_base(plot_background = NULL)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"plot_background hexadecimal string representing color use plot's background. Default: NULL","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_plot_base.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create the base for the ggplot2 instance with the correct theme\nelements — create_plot_base","text":"ggplot2 instance onto features added","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a rectangle — create_rectangle","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"Create set x y coordinates form rectangle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"","code":"create_rectangle(x_min, x_max, y_min, y_max)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"x_min minimum value x x_max maximum value x y_min minimum value y y_max maximum value y","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_rectangle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a rectangle — create_rectangle","text":"data frame containing points needed draw specified rectangle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"Create set x y coordinates form square. function wrapper create_rectangle() ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"","code":"create_square(side_length, center = c(0, 0))"},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"side_length length side square center center coordinates square","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_square.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form a square. This\nfunction is a wrapper on create_rectangle() above — create_square","text":"data frame containing points needed draw specified square","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a set of x and y coordinates that form an ","title":"Create a set of x and y coordinates that form an ","text":"Create set x y coordinates form \"X\"-like shape","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a set of x and y coordinates that form an ","text":"","code":"create_x_shape(bar_length, bar_width, rotation = 45)"},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a set of x and y coordinates that form an ","text":"bar_length length one bars forms \"X\" shape, outer edge outer edge bar_width width one bars forms \"X\" shape, outer edge outer edge rotation angle rotation (degrees) resulting \"X\"-like shape rotated","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/create_x_shape.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a set of x and y coordinates that form an ","text":"data frame containing points needed draw specified \"X\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"back line line back house. outer edge used anchor point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"","code":"curling_back_line(line_thickness = 0, sheet_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"line_thickness thickness back line sheet_width width curling sheet, side wall side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_back_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The back line is the line in the back of the house. Its outer edge should be\nused as its anchor point — curling_back_line","text":"data frame containing bounding box back line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":null,"dir":"Reference","previous_headings":"","what":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"inner-concentric circles comprising house called button. intersection tee line (see curling_tee_line()) centre line (see curling_centre_line())","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"","code":"curling_button(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"feature_radius radius button","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_button.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The inner-most of the concentric circles comprising the house is called the\nbutton. This is the intersection of the tee line (see curling_tee_line())\nand the centre line (see curling_centre_line()) — curling_button","text":"data frame containing bounding coordinates button","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"centre line line runs full length curling sheet, line x = 0 TV view","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"","code":"curling_centre_line( line_thickness = 0, tee_line_to_center = 0, centre_line_extension = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"line_thickness thickness centre line tee_line_to_center distance tee lines. (See curling_tee_line() information) centre_line_extension distance beyond tee lines centre line extends","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The centre line is the line that runs the full length of the curling sheet,\nor the line x = 0 in TV view — curling_centre_line","text":"data frame containing bounding coordinates centre line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"curling sheet entire sheet, houses either top bottom ends. draws area hog lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"","code":"curling_centre_zone( sheet_width = 0, tee_line_to_center = 0, hog_line_to_tee_line = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"sheet_width width curling sheet, side wall side wall tee_line_to_center distance tee line center sheet hog_line_to_tee_line distance center tee line interior edge tee line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_centre_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area between the hog lines — curling_centre_zone","text":"data frame containing bounding box end ice sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"courtesy lines players stand delivery process stone opposing team throwing","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"","code":"curling_courtesy_line(line_thickness = 0, line_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"line_thickness thickness courtesy line line_length length courtesy line, side wall towards centre line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_courtesy_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The courtesy lines are where players stand during the delivery process of\neach stone when the opposing team is throwing — curling_courtesy_line","text":"data frame containing bounding box courtesy line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":null,"dir":"Reference","previous_headings":"","what":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"curling sheet entire sheet, houses either top bottom ends. draws area sheet hog line back board","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"","code":"curling_end( sheet_length = 0, sheet_width = 0, tee_line_to_center = 0, hog_line_to_tee_line = 0, drawn_direction = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"sheet_length length sheet, back board back board sheet_width width curling sheet, side wall side wall tee_line_to_center distance tee line center sheet hog_line_to_tee_line distance center tee line interior edge tee line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_end.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The curling sheet is the entire sheet, with the houses at either the top or\nbottom ends. This draws the area of the sheet from the hog line to the back\nboard — curling_end","text":"data frame containing bounding box end ice sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"","code":"curling_features_set_colors( plot_background = NULL, end_1 = \"#ffffff\", centre_zone = \"#ffffff\", end_2 = \"#ffffff\", sheet_apron = \"#0033a0\", centre_line = \"#000000\", tee_line = \"#000000\", back_line = \"#000000\", hog_line = \"#c8102e\", hack_line = \"#000000\", courtesy_line = \"#000000\", hack = \"#000000\", button = \"#ffffff\", house_rings = c(\"#c8102e\", \"#ffffff\", \"#0033a0\") )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"plot_background hexadecimal string representing color use feature end_1 hexadecimal string representing color use feature centre_zone hexadecimal string representing color use feature end_2 hexadecimal string representing color use feature sheet_apron hexadecimal string representing color use feature centre_line hexadecimal string representing color use feature tee_line hexadecimal string representing color use feature back_line hexadecimal string representing color use feature hog_line hexadecimal string representing color use feature hack_line hexadecimal string representing color use feature courtesy_line hexadecimal string representing color use feature hack hexadecimal string representing color use feature button hexadecimal string representing color use feature house_rings vector hexadecimal strings representing color(s) use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — curling_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":null,"dir":"Reference","previous_headings":"","what":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"hack exits sides curling sheet back board back line. curler pushes , centered centre line (see curling_centre_line()). function draws one footholds hack","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"","code":"curling_hack_foothold(foothold_depth = 0, foothold_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"foothold_depth depth foothold hack, side nearest house side nearest back board foothold_width width foothold hack, side nearest centre line side nearest nearest side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_foothold.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hack exits on both sides of the curling sheet between the back board and\nthe back line. This is where a curler pushes off from, and it should be\ncentered on the centre line (see curling_centre_line()). This function\ndraws one of the footholds of the hack — curling_hack_foothold","text":"data frame containing bounding box one foothold hack","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"hack line connects two footholds hack. anchored terminus centre line (see curling_centre_line() information)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"","code":"curling_hack_line(line_thickness = 0, hack_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"line_thickness thickness hack line hack_width width hack, measured outside one foothold outside ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hack_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hack line connects the two footholds at each hack. It should be anchored\nat the terminus of the centre line (see curling_centre_line() for more\ninformation) — curling_hack_line","text":"data frame containing bounding box hack line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"hog line line begins Free Guard Zone end ice. inner edge (relative nearest house) used anchor point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"","code":"curling_hog_line(line_thickness = 0, sheet_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"line_thickness thickness hog line sheet_width width curling sheet, side wall side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_hog_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hog line is the line that begins the Free Guard Zone at each end of the\nice. Its inner edge (relative to the nearest house) should be used as its\nanchor point — curling_hog_line","text":"data frame containing bounding box hog line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":null,"dir":"Reference","previous_headings":"","what":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"house comprised three concentric circles outside button varying radii. feature designed house rings excluding button","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"","code":"curling_house_ring(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"feature_radius radius ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_house_ring.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The house is comprised of three concentric circles outside of the button of\nvarying radii. This feature is designed to be each of the house rings\nexcluding the button — curling_house_ring","text":"data frame containing bounding coordinates house ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"apron sheet separates adjacent sheets, context provides border around outside sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"","code":"curling_sheet_apron( sheet_length = 0, sheet_width = 0, apron_behind_back = 0, apron_along_side = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"sheet_length length sheet, back board back board sheet_width width curling sheet, side wall side wall apron_behind_back extension apron beyond back board apron_along_side extension apron running along side walls","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_sheet_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The apron of the sheet is what separates adjacent sheets, and in this context\nprovides a border around the outside of the sheet — curling_sheet_apron","text":"data frame containing bounding coordinates sheet's apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"tee line line runs center house. midpoints connected centre line (see curling_centre_line() information)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"","code":"curling_tee_line(line_thickness = 0, sheet_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"line_thickness thickness tee line sheet_width width curling sheet, side wall side wall","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/curling_tee_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The tee line is the line that runs through the center of the house. Its\nmidpoints are connected by the centre line (see curling_centre_line() for\nmore information) — curling_tee_line","text":"data frame containing bounding box tee line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Euclidean distance between two points — distance_formula","title":"Get the Euclidean distance between two points — distance_formula","text":"Get Euclidean distance two points","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Euclidean distance between two points — distance_formula","text":"","code":"distance_formula(point_1_x, point_1_y, point_2_x = 0, point_2_y = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the Euclidean distance between two points — distance_formula","text":"point_1_x point's (vector points') x coordinate point_1_y point's (vector points') y coordinate point_2_x point's (vector points') x coordinate point_2_y point's (vector points') y coordinate","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/distance_formula.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Euclidean distance between two points — distance_formula","text":"distance two supplied points","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"coaching box area restricted area team bench area. may may distinct either areas, typically separated coaching box line (see football_coaching_box_line() information coaching box line)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"","code":"football_coaching_box(coaching_box_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"coaching_box_length length coaching box feature_thickness depth beyond exterior edge restricted area coaching box protrudes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The coaching box is the area between the restricted area and team bench area.\nIt may or may not be distinct from either of these areas, but is typically\nseparated by the coaching box line (see football_coaching_box_line() for\nmore information on the coaching box line) — football_coaching_box","text":"data frame bounding box coaching box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"coaching box line line separates team bench area coaching box. line different color bench area coaching box, may color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"","code":"football_coaching_box_line(coaching_box_line_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"coaching_box_line_length length line forming coaching box line feature_thickness thickness draw line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_coaching_box_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The coaching box line is the line that separates the team bench area from the\ncoaching box. This line should be a different color than the bench area and\ncoaching box, which may be the same color — football_coaching_box_line","text":"data frame bounding box coaching box line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":null,"dir":"Reference","previous_headings":"","what":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"directional arrows point towards nearest goal line yardage marker closest . arrows described base (runs parallel goal line) length, extends tip base","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"","code":"football_directional_arrow(arrow_base = 0, arrow_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"arrow_base length base arrow arrow_length length arrow tip base","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_directional_arrow.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The directional arrows point towards the nearest goal line from the yardage\nmarker they are closest to. These arrows are described by their base (which\nruns parallel to the goal line) and their length, which extends from the tip\nto the base — football_directional_arrow","text":"data frame bounding coordinates directional arrow","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"end line line beyond back endzone. interior edge considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"","code":"football_end_line(feature_thickness = 0, field_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"feature_thickness thickness boundary lines field_width width field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_end_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The end line is the line beyond the back of the endzone. Its interior edge is\nconsidered out of bounds — football_end_line","text":"data frame bounding box end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":null,"dir":"Reference","previous_headings":"","what":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"endzones area beyond goal line. offensive player legal possession ball endzone, catches ball endzone, scores touchdown team. area stretches back field boundary edge goal line closest center field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"","code":"football_endzone(field_width = 0, endzone_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"field_width width field endzone_length length endzone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_endzone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The endzones are the area beyond the goal line. Any offensive player who is\nin legal possession of the ball while in the endzone, or who catches the ball\nin the endzone, scores a touchdown for their team. This area stretches from\nthe back field boundary to the edge of the goal line closest to the center of\nthe field — football_endzone","text":"data frame bounding box endzone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"","code":"football_features_set_colors( plot_background = NULL, field_apron = \"#196f0c\", offensive_half = \"#196f0c\", defensive_half = \"#196f0c\", offensive_endzone = \"#196f0c\", defensive_endzone = \"#196f0c\", end_line = \"#ffffff\", sideline = \"#ffffff\", field_border = \"#196f0c\", field_border_outline = \"#ffffff00\", red_zone_border = \"#196f0c00\", red_zone_border_outline = \"#ffffff00\", major_yard_line = \"#ffffff\", goal_line = \"#ffffff\", minor_yard_line = \"#ffffff\", directional_arrow = \"#ffffff\", try_mark = \"#ffffff\", yardage_marker = \"#ffffff\", restricted_area = \"#ffffff\", coaching_box = \"#ffffff\", team_bench_area = \"#196f0c\", team_bench_area_outline = \"#ffffff\", coaching_box_line = \"#ffcb05\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"plot_background hexadecimal string representing color use feature field_apron hexadecimal string representing color use feature offensive_half hexadecimal string representing color use feature defensive_half hexadecimal string representing color use feature offensive_endzone hexadecimal string representing color use feature defensive_endzone hexadecimal string representing color use feature end_line hexadecimal string representing color use feature sideline hexadecimal string representing color use feature field_border hexadecimal string representing color use feature field_border_outline hexadecimal string representing color use feature red_zone_border hexadecimal string representing color use feature red_zone_border_outline hexadecimal string representing color use feature major_yard_line hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature minor_yard_line hexadecimal string representing color use feature directional_arrow hexadecimal string representing color use feature try_mark hexadecimal string representing color use feature yardage_marker hexadecimal string representing color use feature restricted_area hexadecimal string representing color use feature coaching_box hexadecimal string representing color use feature team_bench_area hexadecimal string representing color use feature team_bench_area_outline hexadecimal string representing color use feature coaching_box_line hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — football_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"field apron appropriately see --bounds features. typically color field , created separately allow customized plotting","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"","code":"football_field_apron( field_length = 0, field_width = 0, endzone_length = 0, boundary_thickness = 0, field_border_thickness = 0, restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, team_bench_area_border_thickness = 0, extra_apron_padding = 0, bench_shape = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"field_length length field field_width width field endzone_length length endzone boundary_thickness thickness field boundary field_border_thickness thickness field border restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length team bench area nearest field team_bench_length_back_side length team bench area furthest field team_bench_width width team bench area team_bench_area_border_thickness thickness border around team bench area extra_apron_padding additional distance add apron field bench_shape string shape bench. Currently, checks \"rectangle\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field should have an apron to appropriately see all out-of-bounds\nfeatures. This is typically the same color as the field itself, but will be\ncreated separately so as to allow for more customized plotting — football_field_apron","text":"data frame bounding coordinates field apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":null,"dir":"Reference","previous_headings":"","what":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"field border border line around outer edge sideline end line. may present every field, sideline end line (although may color)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"","code":"football_field_border( field_length = 0, field_width = 0, feature_thickness = 0, endzone_length = 0, boundary_line_thickness = 0, restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, team_bench_area_border_thickness = 0, surrounds_team_bench_area = FALSE, bench_shape = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"field_length length field field_width width field feature_thickness thickness field border endzone_length length endzone boundary_line_thickness thickness boundary lines restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length side team bench closest field team_bench_length_back_side length side team bench furthest field team_bench_width width team bench team_bench_area_border_thickness thickness border around team bench surrounds_team_bench_area boolean whether field border surround team bench bench_shape string shape bench. Currently, checks \"rectangle\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field border is the border line around the outer edge of the sideline and\nend line. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border","text":"data frame bounding box field border","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"field border's outline outline around outer edge field border. may present every field, sideline end line (although may color)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"","code":"football_field_border_outline( field_length = 0, field_width = 0, feature_thickness = 0, endzone_length = 0, boundary_line_thickness = 0, restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, team_bench_area_border_thickness = 0, field_border_thickness = 0, surrounds_team_bench_area = TRUE, bench_shape = \"\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"field_length length field field_width width field feature_thickness thickness field border's outline endzone_length length endzone boundary_line_thickness thickness boundary lines restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length side team bench closest field team_bench_length_back_side length side team bench furthest field team_bench_width width team bench team_bench_area_border_thickness thickness border around team bench field_border_thickness thickness field border surrounds_team_bench_area boolean whether field border surround team bench bench_shape string shape bench. Currently, checks \"rectangle\"","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_field_border_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field border's outline is the outline around the outer edge of the field\nborder. They may not be present on every field, but this is not the same as\nthe sideline or end line (although they may be the same color) — football_field_border_outline","text":"data frame bounding box field border's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"goal lines lines ball must cross either passed ran order score touchdown. interior edge goal line (relative center field play) lie 0 yard line, center 1 yard line exactly 1 yard edge goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"","code":"football_goal_line(field_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"field_width width field feature_thickness thickness goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal lines are the lines the ball must cross while being either passed or\nran in order to score a touchdown. The interior edge of the goal line\n(relative to the center of the field of play) should lie at the 0 yard line,\nand the center of the 1 yard line should be exactly 1 yard from this edge of\nthe goal line — football_goal_line","text":"data frame bounding box goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":null,"dir":"Reference","previous_headings":"","what":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"half football field spans edge goal line nearest midfield center major yard line midfield","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"","code":"football_half_field(field_length = 0, field_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"field_length length field field_width width field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_half_field.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Each half of the football field spans from the edge of the goal line nearest\nto midfield to the center of the major yard line at midfield — football_half_field","text":"data frame bounding box half football field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"major yard lines yard lines span entire width field. Typically, lines placed every 5 yards, customization left user. lines may feature cross-hash, runs x-direction","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"","code":"football_major_yard_line( field_width = 0, feature_thickness = 0, dist_to_sideline = 0, cross_hash_length = 0, cross_hash_separation = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"field_width width field feature_thickness thickness major yard lines dist_to_sideline distance end yard line interior edge sideline cross_hash_length length cross-hash mark cross_hash_separation interior separation cross-hashes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_major_yard_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The major yard lines are the yard lines that span the entire width of the\nfield. Typically, these lines are placed every 5 yards, but the customization\nis left to the user. These lines may feature a cross-hash, which runs in the\nx-direction — football_major_yard_line","text":"data frame containing bounding box major yard lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"minor yard lines yard lines major yard lines. Typically, four sets minor yard lines: one near sideline, two near middle field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"","code":"football_minor_yard_line(yard_line_height = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"yard_line_height height (y-direction) yard line feature_thickness thickness minor yard line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_minor_yard_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The minor yard lines are the yard lines in between all of the major yard\nlines. Typically, there are four sets of minor yard lines: one near each\nsideline, and two near the middle of the field — football_minor_yard_line","text":"data frame bounding box minor yard line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":null,"dir":"Reference","previous_headings":"","what":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"field border (see football_field_border()) may different color along red zone along rest field. always case, feature provided convenience","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"","code":"football_red_zone_border(feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"feature_thickness thickness field border","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The field border (see football_field_border()) may have a different color\nalong the red zone than it does along the rest of the field. This is not\nalways the case, but the feature is provided for convenience — football_red_zone_border","text":"data frame bounding box red zone border","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"outline football_red_zone_border() may different color rest field border. always case, feature provided convenience","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"","code":"football_red_zone_border_outline(feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"feature_thickness thickness field border's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_red_zone_border_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The outline of the football_red_zone_border() may be a different color than\nthe rest of the field border. This is not always the case, but the feature is\nprovided for convenience — football_red_zone_border_outline","text":"data frame bounding box red zone border's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"restricted area area nearest sideline's exterior edge. area distinct coaching box (immediately behind restricted area) team bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"","code":"football_restricted_area(restricted_area_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"restricted_area_length length restricted area feature_thickness depth beyond exterior edge sideline restricted area protrudes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_restricted_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The restricted area is the area nearest the sideline's exterior edge. This\narea is distinct from the coaching box (immediately behind the restricted\narea) and team bench area — football_restricted_area","text":"data frame bounding coordinates restricted area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"sidelines lines run length field, stretching back one endzone back endzone. interior edge considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"","code":"football_sideline(feature_thickness = 0, field_length = 0, endzone_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"feature_thickness thickness boundary lines field_length length field endzone_length length endzone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sidelines are the lines that run the length of the field, stretching from\nthe back of one endzone to the back of the other endzone. Its interior edge\nis considered out of bounds — football_sideline","text":"data frame bounding box sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"team bench area area beyond restricted area coaching box. team benches, non-playing players, team staff remain game","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"","code":"football_team_bench_area( team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"team_bench_length_field_side length side team bench area closest field team_bench_length_back_side length side team bench area furthest field team_bench_width depth beyond outer edge coaching box line team bench area protrudes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The team bench area is the area beyond the restricted area and coaching box.\nIt is where the team benches, non-playing players, and team staff are to\nremain during the game — football_team_bench_area","text":"data frame bounding coordinates team bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"outline team bench area runs beyond team bench, inside field border may run behind team bench area (see football_field_border() information feature)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"","code":"football_team_bench_area_outline( restricted_area_length = 0, restricted_area_width = 0, coaching_box_length = 0, coaching_box_width = 0, team_bench_length_field_side = 0, team_bench_length_back_side = 0, team_bench_width = 0, feature_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"restricted_area_length length restricted area restricted_area_width width restricted area coaching_box_length length coaching box coaching_box_width width coaching box team_bench_length_field_side length side team bench closest field team_bench_length_back_side length side team bench furthest field team_bench_width width team bench feature_thickness thickness outline team bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_team_bench_area_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The outline of the team bench area runs beyond the team bench, but is inside\nof any field border that may run behind the team bench area (see\nfootball_field_border() for more information on this feature) — football_team_bench_area_outline","text":"data frame containing bounding coordinates team bench area's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"try mark mark tries start. line located directly line y = 0. line typically considered official yard line, created independently","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"","code":"football_try_mark(try_mark_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"try_mark_width width (y-direction) try mark feature_thickness thickness try mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/football_try_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The try mark is the mark from which all tries start. This line is located\ndirectly on the line y = 0. This line is not typically considered an\nofficial yard line, which is why it is created independently — football_try_mark","text":"data frame bounding box try mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"Generate ggplot2 instance containing baseball field specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"","code":"geom_baseball( league, display_range = \"full\", field_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, field_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full field. default \"infield\" infield baseball field field_updates list updates field's parameters. overwrite parameters league color_updates list updates field's default colors, set baseball_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends back tip home plate towards left-handed batter's box (first base side field) y_trans amount y coordinates shifted. convention, +y axis extends back tip home plate towards straight-away center field field_units units draw field. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"ggplot2 instance full-surface representation baseball field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_baseball.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a baseball field for a\nspecified league — geom_baseball","text":"","code":"if (FALSE) { geom_baseball(league = \"MLB\", rotation = 270, display_range = \"infield\") geom_baseball(league = \"little league\", field_units = \"m\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"Generate ggplot2 instance containing basketball court specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"","code":"geom_basketball( league, display_range = \"full\", court_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full court. default \"in_bounds_only\" full -bounds area court \"bounds \" full -bounds area court \"offense\" TV-right half court half-court. considered offensive half court \"offence\" TV-right half court half-court. considered offensive half court \"offensivehalfcourt\" TV-right half court half-court. considered offensive half court \"offensive_half_court\" TV-right half court half-court. considered offensive half court \"offensive half court\" TV-right half court half-court. considered offensive half court \"defense\" TV-left half court half-court. considered defensive half court \"defence\" TV-left half court half-court. considered defensive half court \"defensivehalfcourt\" TV-left half court half-court. considered defensive half court \"defensive_half_court\" TV-left half court half-court. considered defensive half court \"defensive half court\" TV-left half court half-court. considered defensive half court \"offensivekey\" TV-right offensive key (three-point line two-point range) \"offensive_key\" TV-right offensive key (three-point line two-point range) \"offensive key\" TV-right offensive key (three-point line two-point range) \"attackingkey\" TV-right offensive key (three-point line two-point range) \"attacking_key\" TV-right offensive key (three-point line two-point range) \"attacking key\" TV-right offensive key (three-point line two-point range) \"defensivekey\" TV-left defensive key (three-point line two-point range) \"defensive_key\" TV-left defensive key (three-point line two-point range) \"defensive key\" TV-left defensive key (three-point line two-point range) \"defendingkey\" TV-left defensive key (three-point line two-point range) \"defending_key\" TV-left defensive key (three-point line two-point range) \"defending key\" TV-left defensive key (three-point line two-point range) \"offensivepaint\" TV-right offensive free-throw lane \"offensive_paint\" TV-right offensive free-throw lane \"offensive paint\" TV-right offensive free-throw lane \"attackingpaint\" TV-right offensive free-throw lane \"attacking_paint\" TV-right offensive free-throw lane \"attacking paint\" TV-right offensive free-throw lane \"offensivelane\" TV-right offensive free-throw lane \"offensive_lane\" TV-right offensive free-throw lane \"offensive lane\" TV-right offensive free-throw lane \"attackinglane\" TV-right offensive free-throw lane \"attacking_lane\" TV-right offensive free-throw lane \"attacking lane\" TV-right offensive free-throw lane \"defensivepaint\" TV-left defensive free-throw lane \"defensive_paint\" TV-left defensive free-throw lane \"defensive paint\" TV-left defensive free-throw lane \"defendingpaint\" TV-left defensive free-throw lane \"defending_paint\" TV-left defensive free-throw lane \"defending paint\" TV-left defensive free-throw lane \"defensivelane\" TV-left defensive free-throw lane \"defensive_lane\" TV-left defensive free-throw lane \"defensive lane\" TV-left defensive free-throw lane \"defendinglane\" TV-left defensive free-throw lane \"defending_lane\" TV-left defensive free-throw lane \"defending lane\" TV-left defensive free-throw lane court_updates list updates courts' parameters. overwrite parameters league color_updates list updates courts' default colors, set basketball_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center court towards right-hand basket viewing court TV View y_trans amount y coordinates shifted. convention, +y axis extends center court towards top court viewing court TV view court_units units draw court. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"ggplot2 instance full-surface representation basketball court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_basketball.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a basketball court for a\nspecified league — geom_basketball","text":"","code":"if (FALSE) { geom_basketball(league = \"NBA\", rotation = 270, display_range = \"offense\") geom_basketball(league = \"fiba\", court_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"Generate ggplot2 instance containing curling sheet specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"","code":"geom_curling( league, display_range = \"full\", sheet_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, sheet_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full sheet. default \"in_bounds_only\" full -bounds area sheet \"bounds \" full -bounds area sheet \"house\" single house, defaults top house TV view sheet_updates list updates sheet's parameters. overwrite parameters league color_updates list updates sheet's default colors, set curling_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center sheet towards right-hand goal viewing sheet TV View y_trans amount y coordinates shifted. convention, +y axis extends center sheet towards top sheet viewing sheet TV view sheet_units units draw sheet. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"ggplot2 instance full-surface representation curling sheet","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_curling.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a curling sheet for a specified\nleague — geom_curling","text":"","code":"if (FALSE) { geom_curling(league = \"wcf\", rotation = 270, display_range = \"house\") geom_curling(league = \"wcf\", sheet_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"Generate ggplot2 instance containing football field specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"","code":"geom_football( league, display_range = \"full\", field_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, field_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full field. default \"in_bounds_only\" full -bounds area field \"bounds \" full -bounds area field \"offense\" TV-right half field \"offence\" TV-right half field \"offensivehalffield\" TV-right half field \"offensive_half_field\" TV-right half field \"offensive half field\" TV-right half field \"defense\" TV-left half field \"defence\" TV-left half field \"defensivehalffield\" TV-left half field \"defensive_half_field\" TV-left half field \"defensive half field\" TV-left half field \"redzone\" offensive red zone field. definition 20 yards goal line \"red_zone\" offensive red zone field. definition 20 yards goal line \"red zone\" offensive red zone field. definition 20 yards goal line \"oredzone\" offensive red zone field. definition 20 yards goal line \"offensive_red_zone\" offensive red zone field. definition 20 yards goal line \"offensive red zone\" offensive red zone field. definition 20 yards goal line \"dredzone\" defensive red zone field. definition 20 yards goal line \"defensive_red_zone\" defensive red zone field. definition 20 yards goal line \"defensive red zone\" defensive red zone field. definition 20 yards goal line field_updates list updates field's parameters. overwrite parameters league color_updates list updates field's default colors, set football_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center field towards right-hand endzone viewing field TV View y_trans amount y coordinates shifted. convention, +y axis extends center field towards sideline viewing field TV view field_units units draw field. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"ggplot2 instance full-surface representation football field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_football.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a football field for a\nspecified league — geom_football","text":"","code":"if (FALSE) { geom_football(league = \"NFL\", rotation = 270, display_range = \"red_zone\") geom_football(league = \"cfl\", field_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"Generate ggplot2 instance containing ice rink specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"","code":"geom_hockey( league, display_range = \"full\", rink_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, rink_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full ice surface. default \"in_bounds_only\" full -bounds area rink \"bounds \" full -bounds area rink \"offense\" TV-right half rink \"offence\" TV-right half rink \"defense\" TV-left half rink \"defence\" TV-left half rink \"ozone\" TV-right zone rink \"offensive_zone\" TV-right zone rink \"offensive zone\" TV-right zone rink \"attacking_zone\" TV-right zone rink \"attacking zone\" TV-right zone rink \"dzone\" TV-left zone rink \"defensive_zone\" TV-left zone rink \"defensive zone\" TV-left zone rink \"defending_zone\" TV-left zone rink \"defending zone\" TV-left zone rink \"nzone\" middle zone rink \"neutral\" middle zone rink \"neutral_zone\" middle zone rink \"neutral zone\" middle zone rink rink_updates list updates rink's parameters. overwrite parameters league color_updates list updates courts' default colors, set hockey_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center ice surface towards right-hand goal viewing rink TV View y_trans amount y coordinates shifted. convention, +y axis extends center ice surface towards top rink viewing rink TV view rink_units units draw rink. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"ggplot2 instance full-surface representation ice hockey rink","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_hockey.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing an ice rink for a specified\nleague — geom_hockey","text":"","code":"if (FALSE) { geom_hockey(league = \"NHL\", rotation = 270, display_range = \"ozone\") geom_hockey(league = \"iihf\", rink_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"Generate ggplot2 instance containing lacrosse field specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"","code":"geom_lacrosse( league, display_range = \"full\", field_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, field_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full field. default \"offense\" offensive half field. right half field TV view \"offence\" offensive half field. right half field TV view \"offensivehalffield\" offensive half field. right half field TV view \"offensive_half_field\" offensive half field. right half field TV view \"offensive half field\" offensive half field. right half field TV view \"defense\" defensive half field. left half field TV view \"defence\" defensive half field. left half field TV view \"defensivehalffield\" defensive half field. left half field TV view \"defensive_half_field\" defensive half field. left half field TV view \"defensive half field\" defensive half field. left half field TV view field_updates list updates fields' parameters. overwrite parameters league color_updates list updates fields' default colors, set lacrosse_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center field towards right-hand basket viewing field TV View y_trans amount y coordinates shifted. convention, +y axis extends center field towards top field viewing field TV view field_units units draw field. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"ggplot2 instance full-surface representation lacrosse field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_lacrosse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a lacrosse field for a\nspecified league — geom_lacrosse","text":"","code":"if (FALSE) { geom_lacrosse(league = \"NCAA\", rotation = 270, display_range = \"offense\") geom_lacrosse(league = \"FIVB\", field_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"Generate ggplot2 instance containing soccer pitch specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"","code":"geom_soccer( league, display_range = \"full\", pitch_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, pitch_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full pitch. default \"in_bounds_only\" full -bounds area pitch \"bounds \" full -bounds area pitch \"offense\" TV-right half pitch \"offence\" TV-right half pitch \"offensivehalfpitch\" TV-right half pitch \"offensive_half_pitch\" TV-right half pitch \"offensive half pitch\" TV-right half pitch \"defense\" TV-left half pitch \"defence\" TV-left half pitch \"defensivehalfpitch\" TV-left half pitch \"defensive_half_pitch\" TV-left half pitch \"defensive half pitch\" TV-left half pitch pitch_updates list updates pitch's parameters. overwrite parameters league color_updates list updates pitch's default colors, set soccer_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center pitch towards right-hand goal viewing pitch TV View y_trans amount y coordinates shifted. convention, +y axis extends center pitch towards top pitch viewing pitch TV view pitch_units units draw pitch. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"ggplot2 instance full-surface representation soccer pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_soccer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a soccer pitch for a specified\nleague — geom_soccer","text":"","code":"if (FALSE) { geom_soccer(league = \"EPL\", rotation = 270, display_range = \"offense\") geom_soccer(league = \"fifa\", pitch_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"Generate ggplot2 instance containing tennis court specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"","code":"geom_tennis( league, display_range = \"full\", court_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full court. default \"in_bounds_only\" full -bounds area court \"bounds \" full -bounds area court \"serve\" serving half court \"serving\" serving half court \"servicehalf\" serving half court \"service_half\" serving half court \"service half\" serving half court \"servinghalf\" serving half court \"serving_half\" serving half court \"serving half\" serving half court \"receive\" receiving half court \"receiving\" receiving half court \"receivicehalf\" receiving half court \"receivice_half\" receiving half court \"receivice half\" receiving half court \"receivinghalf\" receiving half court \"receiving_half\" receiving half court \"receiving half\" receiving half court court_updates list updates courts' parameters. overwrite parameters league color_updates list updates courts' default colors, set tennis_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center court towards right-hand serviceline viewing court TV View y_trans amount y coordinates shifted. convention, +y axis extends center court towards sideline viewing court TV view court_units units draw court. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"ggplot2 instance full-surface representation tennis court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_tennis.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a tennis court for a specified\nleague — geom_tennis","text":"","code":"if (FALSE) { geom_tennis(league = \"USTA\", rotation = 270, display_range = \"serving\") geom_tennis(league = \"itf\", court_units = \"m\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"Generate ggplot2 instance containing volleyball court specified league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"","code":"geom_volleyball( league, display_range = \"full\", court_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"league league draw surface. case-insensitive display_range case-insensitive string indicating display range use plot. default \"full\", returned either invalid value passed function. possible display ranges : \"full\" full court. default \"in_bounds_only\" full -bounds area court \"bounds \" full -bounds area court \"offense\" offensive half court. right half court TV view \"offence\" offensive half court. right half court TV view \"offensivehalfcourt\" offensive half court. right half court TV view \"offensive_half_court\" offensive half court. right half court TV view \"offensive half court\" offensive half court. right half court TV view \"defense\" defensive half court. left half court TV view \"defence\" defensive half court. left half court TV view \"defensivehalfcourt\" defensive half court. left half court TV view \"defensive_half_court\" defensive half court. left half court TV view \"defensive half court\" defensive half court. left half court TV view court_updates list updates courts' parameters. overwrite parameters league color_updates list updates courts' default colors, set volleyball_features_set_colors() rotation angle, given degrees, plot rotated x_trans amount x coordinates shifted. convention, +x axis extends center court towards right-hand basket viewing court TV View y_trans amount y coordinates shifted. convention, +y axis extends center court towards top court viewing court TV view court_units units draw court. default NULL, apply rule-book specified units xlims limits final display x direction. default NULL, utilize xlims specified display_range parameter ylims limits final display y direction. default NULL, utilize ylims specified display_range parameter","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"ggplot2 instance full-surface representation volleyball court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/geom_volleyball.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a ggplot2 instance containing a volleyball court for a\nspecified league — geom_volleyball","text":"","code":"if (FALSE) { geom_volleyball(league = \"NCAA\", rotation = 270, display_range = \"offense\") geom_volleyball(league = \"FIVB\", court_units = \"ft\") }"},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the default value when not provided in a list — %or%","title":"Set the default value when not provided in a list — %or%","text":"Set default value provided list","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the default value when not provided in a list — %or%","text":"","code":"spec_val %or% default_val"},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the default value when not provided in a list — %or%","text":"spec_val specified value use (assuming provided) default_val value use default","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/grapes-or-grapes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the default value when not provided in a list — %or%","text":"value dependent left-hand value provided, default value specified right hand side","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":null,"dir":"Reference","previous_headings":"","what":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"boards wall around outside rink constrain playing surface. boards typically ovular shape","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"","code":"hockey_boards( rink_length = 0, rink_width = 0, feature_radius = 0, feature_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"rink_length length rink rink_width width rink feature_radius radius corners boards feature_thickness thickness draw boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_boards.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The boards are the wall around the outside of the rink that constrain the\nplaying surface. The boards are typically ovular in shape — hockey_boards","text":"data frame bounding coordinates boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"draws line defining faceoff circle center ice. line circular shape, usually dark blue color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"","code":"hockey_center_faceoff_circle(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"feature_radius radius center faceoff circle feature_thickness thickness line center faceoff circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center faceoff circle is where the each period of the game begins. It\ndiffers from the non-centered faceoff circles in that there are no adjoining\nhash marks on this circle. It is also a different color than the non-centered\nfaceoff circles. Its line thickness should be given by 'minor_line_thickness'\nas this is a minor line on the ice surface — hockey_center_faceoff_circle","text":"data frame containing bounding coordinates center faceoff circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":null,"dir":"Reference","previous_headings":"","what":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"center faceoff spot spot game begins. center lie directly center ice surface. radius passed key rink_params","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"","code":"hockey_center_faceoff_spot(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"feature_radius radius center faceoff spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_faceoff_spot.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center faceoff spot is the spot at which the game begins. Its center\nshould lie directly in the center of the ice surface. Its radius is passed as\na key in rink_params — hockey_center_faceoff_spot","text":"data frame containing bounding coordinates center faceoff spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"center line line divides ice surface half. center lie directly center ice surface. line thickness given 'major_line_thickness' major line ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"","code":"hockey_center_line( feature_thickness = 0, rink_width = 0, center_faceoff_spot_gap = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"feature_thickness thickness center line rink_width width rink","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_center_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center line is the line that divides the ice surface in half. Its center\nshould lie directly in the center of the ice surface. Its line thickness\nshould be given by 'major_line_thickness' as this is a major line on the ice\nsurface — hockey_center_line","text":"data frame bounding coordinates center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The defensive zone is the left ","title":"The defensive zone is the left ","text":"defensive zone left \"third\" rink TV view. area team defends attacking left right","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The defensive zone is the left ","text":"","code":"hockey_defensive_zone( rink_length = 0, rink_width = 0, feature_radius = 0, nzone_length = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The defensive zone is the left ","text":"rink_length length rink rink_width width rink feature_radius radius corners boards nzone_length length neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_defensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The defensive zone is the left ","text":"data frame bounding coordinates defensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"","code":"hockey_features_set_colors( plot_background = NULL, boards = \"#000000\", ozone_ice = \"#ffffff\", nzone_ice = \"#ffffff\", dzone_ice = \"#ffffff\", center_line = \"#c8102e\", zone_line = \"#0033a0\", goal_line = \"#c8102e\", restricted_trapezoid = \"#c8102e\", goal_crease_outline = \"#c8102e\", goal_crease_fill = \"#41b6e6\", referee_crease = \"#c8102e\", center_faceoff_spot = \"#0033a0\", faceoff_spot_ring = \"#c8102e\", faceoff_spot_stripe = \"#c8102e\", center_faceoff_circle = \"#0033a0\", odzone_faceoff_circle = \"#c8102e\", faceoff_line = \"#c8102e\", goal_frame = \"#c8102e\", goal_fill = \"#a5acaf4d\", team_a_bench = \"#ffffff\", team_b_bench = \"#ffffff\", team_a_penalty_box = \"#ffffff\", team_b_penalty_box = \"#ffffff\", off_ice_officials_box = \"#a5acaf\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"plot_background hexadecimal string representing color use feature boards hexadecimal string representing color use feature ozone_ice hexadecimal string representing color use feature nzone_ice hexadecimal string representing color use feature dzone_ice hexadecimal string representing color use feature center_line hexadecimal string representing color use feature zone_line hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature restricted_trapezoid hexadecimal string representing color use feature goal_crease_outline hexadecimal string representing color use feature goal_crease_fill hexadecimal string representing color use feature referee_crease hexadecimal string representing color use feature center_faceoff_spot hexadecimal string representing color use feature faceoff_spot_ring hexadecimal string representing color use feature faceoff_spot_stripe hexadecimal string representing color use feature center_faceoff_circle hexadecimal string representing color use feature odzone_faceoff_circle hexadecimal string representing color use feature faceoff_line hexadecimal string representing color use feature goal_frame hexadecimal string representing color use feature goal_fill hexadecimal string representing color use feature team_a_bench hexadecimal string representing color use feature team_b_bench hexadecimal string representing color use feature team_a_penalty_box hexadecimal string representing color use feature team_b_penalty_box hexadecimal string representing color use feature off_ice_officials_box hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — hockey_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"filling goal crease thickness given 'minor_line_thickness', refers crease's outline, minor line ice surface. goal crease's filling usually light color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"","code":"hockey_goal_crease_fill( feature_radius = 0, feature_thickness = 0, crease_style = \"\", crease_length = 0, crease_width = 0, notch_dist_x = 0, notch_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"feature_radius radius goal crease feature_thickness thickness line marking outline goal crease crease_style style goal crease crease_length length goal crease crease_width width goal crease notch_dist_x distance back edge goal line edge crease notch notch_width width notch goal crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease (see\nhockey_goal_crease_outline()), and the filling in its boundary. The goal\ncrease may have two notches (one on each side of the line y = 0) — hockey_goal_crease_fill","text":"data frame containing bounding coordinates goal crease's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"outline goal crease thickness given 'minor_line_thickness', minor line ice surface, outline usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"","code":"hockey_goal_crease_outline( feature_radius = 0, feature_thickness = 0, crease_style = \"\", crease_length = 0, crease_width = 0, notch_dist_x = 0, notch_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"feature_radius radius goal crease feature_thickness thickness line marking outline goal crease crease_style style goal crease crease_length length goal crease crease_width width goal crease notch_dist_x distance back edge goal line edge crease notch notch_width width notch goal crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_crease_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal crease is the area where a goaltender plays their position. It is\ncomprised of two components: the outline of the crease, and the filling in\nits boundary (see hockey_goal_crease_fill()). The goal crease may have two\nnotches (one on each side of the line y = 0) — hockey_goal_crease_outline","text":"data frame containing bounding coordinates goal crease's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"goal frame two thicknesses careful : outer diameter posts, outer diameter pipe back goal. frame goal usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"","code":"hockey_goal_frame( feature_radius = 0, goal_mouth_width = 0, goal_back_width = 0, goal_depth = 0, goal_post_diameter = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"feature_radius radius circular part goal frame goal_mouth_width width goal mouth goal_back_width width back frame goal goal_depth depth goal front goal line back goal frame goal_post_diameter diameter post goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (this method) and\nthe fill (see hockey_goal_frame_fill()) — hockey_goal_frame","text":"data frame containing bounding coordinates frame goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"goal frame two thicknesses careful : outer diameter posts, outer diameter pipe back goal. frame goal usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"","code":"hockey_goal_frame_fill( feature_radius = 0, goal_mouth_width = 0, goal_back_width = 0, goal_depth = 0, goal_post_diameter = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"feature_radius radius circular part goal frame goal_mouth_width width goal mouth goal_back_width width back frame goal goal_depth depth goal front goal line back goal frame goal_post_diameter diameter post goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_frame_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal frame is where the puck enters after crossing the goal line to score\na legal goal. The front face of the goal is flush with the goal line, while\nthe back edge features rounded corners and expands outside of the front\nposts. The goal frame is composed of two pieces: the frame (see\nhockey_goal_frame()) and the fill (this function) — hockey_goal_frame_fill","text":"data frame containing bounding coordinates frame goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"draws right-side goal line (TV view), starting left edge. also accounts perfectly rectangular goal line user supplies value necessitates one. line rectangular shape rounded ends, usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"","code":"hockey_goal_line( rink_length = 0, rink_width = 0, feature_radius = 0, feature_thickness = 0, x_anchor = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"rink_length length rink rink_width width rink feature_radius radius corner rink feature_thickness thickness goal line x_anchor x coordinate used anchor point goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal lines are the lines over which a puck must cross (within the goal\nframe) in order to be considered a goal. Its line thickness should be given\nby 'minor_line_thickness' as this is a minor line on the ice surface. — hockey_goal_line","text":"data frame containing bounding coordinates goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":null,"dir":"Reference","previous_headings":"","what":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"NOTE: requirement leagues, may omitted via \"has_trapezoid\" key rink_params passed geom_{league}","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"","code":"hockey_goaltenders_restricted_area( rink_length = 0, feature_thickness = 0, short_base_width = 0, long_base_width = 0, x_anchor = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"rink_length length rink feature_thickness thickness lines used draw goaltender's restricted area short_base_width width base nearest center line long_base_width width base nearest boards behind goal x_anchor x coordinate used anchor point goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"data frame containing bounding coordinates goaltender's restricted area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_goaltenders_restricted_area.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The goaltender's restricted area marks where a goaltender is legally allowed\nto handle the puck behind the net. This is often referred to as ","text":"draws goaltender's restricted area right side (TV view) ice surface. figure composed lines outline trapezoid shape, usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The neutral zone is the middle ","title":"The neutral zone is the middle ","text":"neutral zone middle \"third\" rink. area two zone (blue) lines. center neutral zone lie along line x = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The neutral zone is the middle ","text":"","code":"hockey_neutral_zone(rink_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The neutral zone is the middle ","text":"rink_width width rink feature_thickness length neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_neutral_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The neutral zone is the middle ","text":"data frame containing bounding coordinates neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":null,"dir":"Reference","previous_headings":"","what":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"function responsible creating outer ring, colored stripe running . Please see hockey_nodzone_faceoff_spot_stripe() information ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"","code":"hockey_nodzone_faceoff_spot_ring(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"feature_radius outer radius non-centered faceoff spot ring feature_thickness thickness non-centered faceoff spot ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"data frame containing bounding coordinates non-centered faceoff spot ring","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_ring.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_ring","text":"non-centered faceoff spots faceoffs taken icing call start powerplay. differ center ice faceoff spot size, color, form. thickness given 'minor_line_thickness' minor lines ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":null,"dir":"Reference","previous_headings":"","what":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"function responsible creating inner stripe, colored outer ring around . Please see hockey_nodzone_faceoff_spot_ring() information ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"","code":"hockey_nodzone_faceoff_spot_stripe( feature_radius = 0, feature_thickness = 0, gap_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"feature_radius outer radius non-centered faceoff spot feature_thickness thickness non-centered faceoff spot ring gap_width width gap inner edge non-centered faceoff spot ring outer edge stripe","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"data frame containing bounding coordinates non-centered faceoff spot's stripe","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_nodzone_faceoff_spot_stripe.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The non-centered faceoff spots are located in the neutral, offensive and\ndefensive zones of the ice, with one on each side of the x-axis when viewing\nthe rink in TV view. These spots differ from the center faceoff spot because\nthey have a larger diameter, differ in color, and have a colored stripe that\nruns through its center. — hockey_nodzone_faceoff_spot_stripe","text":"non-centered faceoff spots faceoffs taken icing call start powerplay. differ center ice faceoff spot size, color, form. faceoff spot's stripe, 'feature_thickness' parameter thickness outer ring, 'minor_line_thickness'","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"non-centered faceoff circles faceoffs taken icing call start powerplay. differ center ice faceoff circle adjoining hash marks circles. also different color center ice faceoff circle, spot center varies size form. line thickness given 'minor_line_thickness' minor line ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"","code":"hockey_odzone_faceoff_circle( feature_radius = 0, feature_thickness = 0, hashmark_width = 0, hashmark_ext_spacing = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"feature_radius radius faceoff circle feature_thickness thickness line non-centered faceoff circle hashmark_width width hashmarks exterior non-centered faceoff circle hashmark_ext_spacing external spacing hashmarks' outer edges","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The non-centered faceoff circles are located in the offensive and defensive\nzones of the ice, with one on each side of the x-axis when viewing the rink\nin TV view. These circles differ from the center faceoff circle because they\nhave hash marks that extend towards the boards on each side of the circle — hockey_odzone_faceoff_circle","text":"data frame containing bounding coordinates non-centered faceoff circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":null,"dir":"Reference","previous_headings":"","what":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"lines L-shaped, can thought two rectangles thickness given 'minor_line_thickness', usually red color","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"","code":"hockey_odzone_faceoff_lines( feature_thickness = 0, faceoff_line_dist_x = 0, faceoff_line_dist_y = 0, faceoff_line_length = 0, faceoff_line_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"feature_thickness thickness faceoff lines faceoff_line_dist_x distance center faceoff spot interior edge faceoff lines x direction faceoff_line_dist_y distance center faceoff spot interior edge faceoff lines y direction faceoff_line_length length faceoff lines edge nearest goal line edge nearest end boards faceoff_line_width width faceoff lines edge nearest center spot edge nearest side boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_odzone_faceoff_lines.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The offensive/defensive zone faceoff lines are the L-shaped lines where\nplayers on each team line up when taking a faceoff in either the offensive or\ndefensive zones. There are four of these faceoff lines around each\noffensive/defensive faceoff spot — hockey_odzone_faceoff_lines","text":"data frame containing bounding coordinates offensive/defensive zone faceoff lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"thickness boards, located outside ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"","code":"hockey_off_ice_officials_box( feature_thickness = 0, officials_box_length = 0, officials_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"feature_thickness thickness outline -ice officials' box officials_box_length length -ice officials' box officials_box_depth depth -ice officials' box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_off_ice_officials_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The off-ice officials' box is located between the two penalty boxes, opposite\nthe team bench areas — hockey_off_ice_officials_box","text":"data frame containing bounding coordinates -ice officials' box's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The offensive zone is the right ","title":"The offensive zone is the right ","text":"offensive zone right \"third\" rink TV view. area team attacks try score goal attacking left right","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The offensive zone is the right ","text":"","code":"hockey_offensive_zone( rink_length = 0, rink_width = 0, feature_radius = 0, nzone_length = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The offensive zone is the right ","text":"rink_length length rink rink_width width rink feature_radius radius corners boards nzone_length length neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_offensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The offensive zone is the right ","text":"data frame bounding coordinates offensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"thickness boards, located outside ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"","code":"hockey_penalty_box_fill( feature_thickness = 0, penalty_box_length = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"feature_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will not include the off-ice officials' box; see\nhockey_off_ice_officials_box() for more information — hockey_penalty_box_fill","text":"data frame containing bounding coordinates penalty box's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"thickness boards, located outside ice surface. penalty box's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"","code":"hockey_penalty_box_outline( feature_thickness = 0, penalty_box_length = 0, penalty_box_width = 0, penalty_box_separation = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"feature_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_separation separation two penalty boxes penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_penalty_box_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the rink where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe ice surface and separate, as close to center ice as possible, for each\nteam. This will also include the off-ice officials' box — hockey_penalty_box_outline","text":"data frame containing bounding coordinates penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"thickness boards, located outside ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"","code":"hockey_player_bench_area_fill( feature_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"feature_thickness thickness outline player bench area bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_area_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_area_fill","text":"data frame containing bounding coordinates player bench area's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"thickness boards, located outside ice surface. bench's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"","code":"hockey_player_bench_outline( feature_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"feature_thickness thickness outline player bench areas bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_player_bench_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the rink where\nplayers not currently on the ice are seated. They are to be on the same side\nof the ice surface and separate, as close to center ice as possible — hockey_player_bench_outline","text":"data frame containing bounding coordinates player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":null,"dir":"Reference","previous_headings":"","what":"The referee's crease is a semi-circle on the ","title":"The referee's crease is a semi-circle on the ","text":"referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The referee's crease is a semi-circle on the ","text":"","code":"hockey_referee_crease(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The referee's crease is a semi-circle on the ","text":"feature_radius radius referee's crease feature_thickness thickness draw referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_referee_crease.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The referee's crease is a semi-circle on the ","text":"data frame bounding coordinates referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"zone lines lines separate neutral zone offensive defensive zones. line thickness given 'major_line_thickness' major line ice surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"","code":"hockey_zone_line(rink_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"rink_width width rink feature_thickness thickness zone line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/hockey_zone_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The zone lines are the lines that separate the neutral zone from the\noffensive and defensive zones. Its line thickness should be given by\n'major_line_thickness' as this is a major line on the ice surface — hockey_zone_line","text":"data frame containing bounding coordinates zone line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify if a passed color is a hexadecimal string — is_hex","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"Identify passed color hexadecimal string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"","code":"is_hex(col_str = \"\")"},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"col_str potentially-hexadecimal string check","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/is_hex.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify if a passed color is a hexadecimal string — is_hex","text":"boolean indicating string fact hexadecimal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":null,"dir":"Reference","previous_headings":"","what":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"fields, goal marking. circles mirror , center points used anchors","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"","code":"lacrosse_below_goal_marking(below_goal_marking_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"below_goal_marking_radius radius goal marking","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_below_goal_marking.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"On some fields, there is a below goal marking. These are circles that should\nmirror each other, with their center points used as anchors — lacrosse_below_goal_marking","text":"data frame containing bounding coordinates goal marking","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":null,"dir":"Reference","previous_headings":"","what":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"boards wall around outside field constrain playing surface. boards either typically ovular shape, present field outdoors","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"","code":"lacrosse_boards( field_length = 0, field_width = 0, corner_radius = 0, boundary_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"field_length length field field_width width field corner_radius radius corners boards boundary_thickness thickness draw boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_boards.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The boards are the wall around the outside of the field that constrain the\nplaying surface. The boards are either typically ovular in shape, or not\npresent if the field is outdoors — lacrosse_boards","text":"data frame bounding coordinates boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"center circle play begins start game. located center field (present)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"","code":"lacrosse_center_circle(center_circle_radius = 0, center_circle_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"center_circle_radius outer radius center circle center_circle_thickness thickness center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is where play begins to start a game. This is located at\nthe center of the field (when present) — lacrosse_center_circle","text":"data frame containing bounding coordinates center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"center line divides field play two equal halves, generated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), lacrosse_neutral_zone(). line may stretch entire width field, parameter created instead","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"","code":"lacrosse_center_line(center_line_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"center_line_width width center line (distance y) line_thickness thickness center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_center_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center line divides the field of play into two equal halves, which are\ngenerated via lacrosse_offensive_zone(), lacrosse_defensive_zone(), and\nlacrosse_neutral_zone(). This line may not stretch the entire width of the\nfield, so a parameter is created instead — lacrosse_center_line","text":"data frame containing bounding coordinates center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"change area box-shaped area front team benches substitutions occur. feature describes interior fill; outline controlled lacrosse_change_area_outline()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"","code":"lacrosse_change_area_fill(change_area_length = 0, change_area_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"change_area_length length change area's interior change_area_width distance boards change area extends playing surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its interior fill; its outline\nis controlled by lacrosse_change_area_outline() — lacrosse_change_area_fill","text":"data frame containing bounding coordinates change area's interior fill","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"change area box-shaped area front team benches substitutions occur. feature describes outline; interior fill controlled lacrosse_change_area_fill()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"","code":"lacrosse_change_area_outline( change_area_length = 0, change_area_width = 0, feature_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"change_area_length length change area's interior change_area_width distance boards change area extends playing surface feature_thickness thickness outline box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_change_area_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The change area is the box-shaped area in front of the team benches where a\nsubstitutions occur. This feature describes its outline; its interior fill\nis controlled by lacrosse_change_area_fill() — lacrosse_change_area_outline","text":"data frame containing bounding coordinates change area's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"defensive-area lines run parallel sidelines connected end line (see lacrosse_end_line()) restraining line (see lacrosse_restraining_line()) features present","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"","code":"lacrosse_defensive_area_line( defensive_area_line_length = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"defensive_area_line_length length defensive-area line length line_thickness thickness defensive area line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_area_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The defensive-area lines run parallel to the sidelines and are connected to\nthe end line (see lacrosse_end_line()) and restraining line (see\nlacrosse_restraining_line()) when these features are present — lacrosse_defensive_area_line","text":"data frame containing bounding coordinates defensive area lines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"defensive zone TV-left area playing surface. many cases, correspond half field's length","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"","code":"lacrosse_defensive_zone( field_length = 0, field_width = 0, corner_radius = 0, nzone_length = 0, field_shape = \"rectangle\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"field_length interior length field field_width interior width field corner_radius radius corner (assuming field_shape = \"oval\"). Viable options \"rectangle\" \"oval\" nzone_length length neutral zone field_shape shape field, passed string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_defensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The defensive zone is the TV-left area of the playing surface. In many cases,\nthis will correspond to half of the field's length — lacrosse_defensive_zone","text":"data frame containing bounding coordinates defensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"end lines run width field, interior edge designating -bounds area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"","code":"lacrosse_end_line(field_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"field_width interior width field line_thickness thickness end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_end_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The end lines run the width of the field, with its interior edge designating\nthe in-bounds area — lacrosse_end_line","text":"data frame containing bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":null,"dir":"Reference","previous_headings":"","what":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"face-markers face-offs occur. may take one two forms: \"X\" shape circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"","code":"lacrosse_face_off_marker( shape = \"O\", feature_thickness = 0, side_length = 0, feature_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"shape one following strings (case-insensitive): \"X\" \"X\"-like shape. must specified feature_thickness parameter specify width bar \"X\", side_length parameter control length bar \"O\" circle shape. must specified feature_radius parameter determine size circle feature_thickness thickness single bar \"X\" shape side_length length single bar \"X\" shape feature_radius radius circular face-spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_face_off_marker.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The face-off markers are where face-offs occur. They may take one of two\nforms: an ","text":"data frame containing bounding coordinates face-spot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"","code":"lacrosse_features_set_colors( plot_background = NULL, field_apron = \"#195f0c\", defensive_zone = \"#195f0c\", neutral_zone = \"#195f0c\", offensive_zone = \"#195f0c\", team_a_bench = \"#a5acaf4d\", team_b_bench = \"#a5acaf4d\", team_a_penalty_box = \"#a5acaf4d\", team_b_penalty_box = \"#a5acaf4d\", off_field_officials_box = \"#a5acaf\", boards = \"#ffa500\", end_line = \"#ffffff\", sideline = \"#ffffff\", center_line = \"#ffffff\", wing_line = \"#ffffff\", restraining_line = \"#ffffff\", defensive_area_line = \"#ffffff\", goal_line = \"#ffffff\", referee_crease = \"#ffffff\", referee_crease_fill = \"#195f0c\", goal_circle = \"#ffffff\", goal_circle_fill = \"#195f0c\", goal_arc = \"#ffffff\", goal_fan = \"#ffffff\", goal_fan_hash_mark = \"#ffffff\", goal_mouth_hash_mark = \"#ffffff\", goal_mouth = \"#ffffff\", below_goal_marking = \"#ffffff\", goal_frame = \"#ffa500\", goal_net = \"#a5acaf4d\", center_circle = \"#ffffff\", center_face_off_marker = \"#ffffff\", corner_face_off_marker = \"#ffffff\", change_area_outline = \"#ffffff\", change_area_fill = \"#195f0c\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"plot_background hexadecimal string representing color use feature field_apron hexadecimal string representing color use feature defensive_zone hexadecimal string representing color use feature neutral_zone hexadecimal string representing color use feature offensive_zone hexadecimal string representing color use feature team_a_bench hexadecimal string representing color use feature team_b_bench hexadecimal string representing color use feature team_a_penalty_box hexadecimal string representing color use feature team_b_penalty_box hexadecimal string representing color use feature off_field_officials_box hexadecimal string representing color use feature boards hexadecimal string representing color use feature end_line hexadecimal string representing color use feature sideline hexadecimal string representing color use feature center_line hexadecimal string representing color use feature wing_line hexadecimal string representing color use feature restraining_line hexadecimal string representing color use feature defensive_area_line hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature referee_crease hexadecimal string representing color use feature referee_crease_fill hexadecimal string representing color use feature goal_circle hexadecimal string representing color use feature goal_circle_fill hexadecimal string representing color use feature goal_arc hexadecimal string representing color use feature goal_fan hexadecimal string representing color use feature goal_fan_hash_mark hexadecimal string representing color use feature goal_mouth_hash_mark hexadecimal string representing color use feature goal_mouth hexadecimal string representing color use feature below_goal_marking hexadecimal string representing color use feature goal_frame hexadecimal string representing color use feature goal_net hexadecimal string representing color use feature center_circle hexadecimal string representing color use feature center_face_off_marker hexadecimal string representing color use feature corner_face_off_marker hexadecimal string representing color use feature change_area_outline hexadecimal string representing color use feature change_area_fill hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — lacrosse_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"Outdoor require field apron boundary lines visible","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"","code":"lacrosse_field_apron( field_length = 0, field_width = 0, field_apron_thickness = 0, field_shape = \"rectangle\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"field_length length field field_width width field field_apron_thickness thickness field apron field_shape shape field, passed string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_field_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Outdoor require should have a field apron so that boundary lines are more\nvisible — lacrosse_field_apron","text":"data frame bounding coordinates field apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":null,"dir":"Reference","previous_headings":"","what":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"arc around goal circle semi-circular area located around goal circle (see lacrosse_goal_circle()) may extend back end line, also may cut goal line extended. extension controlled via goal_arc_extension parameter. Note: hash marks generated via lacrosse_goal_fan_hash_mark()","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"","code":"lacrosse_goal_arc( goal_arc_extension = 0, goal_arc_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"goal_arc_extension extension goal line towards end line goal_arc_radius outer radius goal arc, measured center goal line line_thickness thickness goal arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_arc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The arc around the goal circle is a semi-circular area located around the\ngoal circle (see lacrosse_goal_circle()) that may extend back to the end\nline, but also may be cut off at the goal line extended. The extension should\nbe controlled via the goal_arc_extension parameter. Note: the hash\nmarks are generated via lacrosse_goal_fan_hash_mark() — lacrosse_goal_arc","text":"data frame containing bounding coordinates goal arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"goal circle circular feature field houses goal line (see lacrosse_goal_line()) goal. Notably, fields surrounding arc /fan around goal area, feature circumscribes goal. features handled separately. feature may either full circle (e.g. 360 degrees), partial circle may greater half-circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"","code":"lacrosse_goal_circle( goal_circle_radius = 0, line_thickness = 0, goal_circle_full_360 = TRUE, goal_depth = 0, goal_depth_to_circle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"goal_circle_radius outer radius goal circle line_thickness thickness goal circle goal_circle_full_360 boolean indicating whether goal circle 360 degree circle goal_depth depth goal goal_depth_to_circle distance back tip goal outer radius goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal circle is a circular feature on the field that houses the goal line\n(see lacrosse_goal_line()) and the goal. Notably, for fields with a\nsurrounding arc and/or fan around the goal area, this feature only\ncircumscribes the goal. Those features will be handled separately. This\nfeature may either be the full circle (e.g. all 360 degrees), or a partial\ncircle that may be greater than a half-circle — lacrosse_goal_circle","text":"data frame containing bounding coordinates goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"feature area enclosed goal circle's outline. Please see lacrosse_goal_circle() information","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"","code":"lacrosse_goal_circle_fill( goal_circle_radius = 0, line_thickness = 0, goal_circle_full_360 = TRUE, goal_depth = 0, goal_depth_to_circle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"goal_circle_radius outer radius goal circle line_thickness thickness goal circle goal_circle_full_360 boolean indicating whether goal circle 360 degree circle goal_depth depth goal goal_depth_to_circle distance back tip goal outer radius goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_circle_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"This feature is the area enclosed by the goal circle's outline. Please see\nlacrosse_goal_circle() for more information — lacrosse_goal_circle_fill","text":"data frame containing bounding coordinates goal circle's enclosed area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"goal arc fan present fields (e.g. NCAAW) quarter-circle located around goal. anchor feature given center goal line, radius arc actually corresponds point goal circle (see lacrosse_goal_circle()) runs y = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"","code":"lacrosse_goal_fan( goal_fan_radius = 0, goal_circle_radius = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"goal_fan_radius outer radius goal fan, measured center goal line outer edge goal fan goal_circle_radius radius goal circle line_thickness thickness goal fan line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal arc fan is present on some fields (e.g. NCAAW) as a quarter-circle\nlocated around the goal. The anchor for this feature should be given as the\ncenter of the goal line, but the radius of the arc actually corresponds to\na point on the goal circle (see lacrosse_goal_circle()) that runs through\ny = 0 — lacrosse_goal_fan","text":"data frame containing bounding coordinates goal fan","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"hash marks around goal fan (see lacrosse_goal_fan()) drawn independently goal fan . just rectangles anchor points along circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"","code":"lacrosse_goal_fan_hash_mark( goal_fan_hash_mark_length = 0, line_thickness = 0, rotational_angle = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"goal_fan_hash_mark_length length hash mark along goal fan line_thickness thickness hash mark along goal fan rotational_angle angle (degrees) hash mark rotated","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_fan_hash_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The hash marks around the goal fan (see lacrosse_goal_fan()) are drawn\nindependently from the goal fan itself. These should just be rectangles with\nanchor points along the circle — lacrosse_goal_fan_hash_mark","text":"data frame containing bounding coordinates hash mark along goal fan","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"goal frame posts ball must pass order score goal. usually triangular shape","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"","code":"lacrosse_goal_frame( goal_frame_opening_interior = 0, goal_post_thickness = 0, goal_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"goal_frame_opening_interior interior width goal frame's opening goal_post_thickness thickness goal post goal_depth outer depth goal anchored","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_frame.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal frame is the posts through which the ball must pass in order to\nscore a goal. It is usually triangular in shape — lacrosse_goal_frame","text":"data frame containing bounding coordinates goal frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"goal line front edge goal sits. spans entire interior dimension goal mouth. anchoring x coordinate center (e.g. half line's width side x anchor)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"","code":"lacrosse_goal_line( goal_frame_width = 0, line_thickness = 0, goal_line_full_diameter = FALSE, goal_circle_radius = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"goal_frame_width interior width goal frame's opening line_thickness thickness goal line goal_line_full_diameter Whether goal line extend full diameter lacrosse_goal_circle() goal_circle_radius outer radius goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal line is where the front edge of the goal sits. It spans the entire\ninterior dimension of the goal mouth. Its anchoring x coordinate\nshould be its center (e.g. half of the line's width should be on each side of\nthe x anchor) — lacrosse_goal_line","text":"data frame containing bounding coordinates goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"goal mouth similar goal fan, except plainly semi-circle located front goal fields appears. separation ends typically correspond diameter goal circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"","code":"lacrosse_goal_mouth( goal_mouth_radius = 0, line_thickness = 0, goal_mouth_semi_circle_separation = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"goal_mouth_radius outer radius goal mouth line_thickness thickness line marking goal mouth goal_mouth_semi_circle_separation separation ends flat part semi-circle goal mouth","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal mouth is similar to the goal fan, except it is plainly a semi-circle\nlocated in front of the goal on fields for which it appears. The separation\nbetween the ends of it typically correspond to the diameter of the goal\ncircle — lacrosse_goal_mouth","text":"data frame containing bounding coordinates goal mouth","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"goal mouth may hash mark extends towards midfield goal line extended. hash mark, anchored using outer edge","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"","code":"lacrosse_goal_mouth_hash_mark( goal_mouth_hash_mark_length = 0, line_thickness = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"goal_mouth_hash_mark_length length goal line extended towards center field hash mark extends line_thickness thickness hash mark extending goal mouth","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_mouth_hash_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal mouth may have a hash mark that extends towards midfield from the\ngoal line extended. This is that hash mark, and should be anchored using its\nouter edge — lacrosse_goal_mouth_hash_mark","text":"data frame containing bounding coordinates goal mouth's hash mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"goal net netting ball must hit order score point","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"","code":"lacrosse_goal_net( goal_frame_opening_interior = 0, goal_post_thickness = 0, goal_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"goal_frame_opening_interior interior width goal frame's opening goal_post_thickness thickness goal post goal_depth outer depth goal anchored","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_goal_net.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal net is the netting that the ball must hit in order to score a point — lacrosse_goal_net","text":"data frame containing bounding coordinates goal net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"neutral zone corresponds area restraining lines. cases restraining lines, feature 0 length","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"","code":"lacrosse_neutral_zone(nzone_length = 0, field_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"nzone_length length neutral zone field_width width field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_neutral_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The neutral zone corresponds to the area between the restraining lines. In\ncases where there are no restraining lines, this feature will have 0 length — lacrosse_neutral_zone","text":"data frame containing bounding coordinates neutral zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"thickness boards, located outside field surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"","code":"lacrosse_off_field_officials_box( officials_box_thickness = 0, officials_box_length = 0, officials_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"officials_box_thickness thickness outline -field officials' box officials_box_length length -field officials' box officials_box_depth depth -field officials' box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_off_field_officials_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The off-field officials' box is located between the two penalty boxes,\nopposite the team bench areas — lacrosse_off_field_officials_box","text":"data frame containing bounding coordinates -field officials' box's outline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"offensive zone team tries score goal. TV-right area field","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"","code":"lacrosse_offensive_zone( field_length = 0, field_width = 0, corner_radius = 0, nzone_length = 0, field_shape = \"rectangle\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"field_length interior length field field_width interior width field corner_radius radius corner (assuming field_shape = \"oval\"). Viable options \"rectangle\" \"oval\" nzone_length length neutral zone field_shape shape field, passed string","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_offensive_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The offensive zone is where a team tries to score a goal. It is the TV-right\narea on the field — lacrosse_offensive_zone","text":"data frame bounding coordinates offensive zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"thickness boards, located outside field surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"","code":"lacrosse_penalty_box_fill( penalty_box_outline_thickness = 0, penalty_box_length = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"penalty_box_outline_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will not include the off-field officials' box; see\nlacrosse_off_field_officials_box() for more information — lacrosse_penalty_box_fill","text":"data frame containing bounding coordinates penalty box's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"thickness boards, located outside field surface. penalty box's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"","code":"lacrosse_penalty_box_outline( penalty_box_outline_thickness = 0, penalty_box_length = 0, penalty_box_width = 0, penalty_box_separation = 0, penalty_box_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"penalty_box_outline_thickness thickness outline penalty box penalty_box_length length penalty box penalty_box_width width penalty box penalty_box_separation separation two penalty boxes penalty_box_depth depth penalty box extends outer edge boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_penalty_box_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty boxes are the areas outside the confines of the field where\nplayers serve time for a penalty incurred. They are to be on the same side of\nthe field surface and separate, as close to center field as possible, for\neach team. This will also include the off-field officials' box — lacrosse_penalty_box_outline","text":"data frame containing bounding coordinates penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"thickness boards, located outside field surface","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"","code":"lacrosse_player_bench_area_fill( bench_area_outline_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"bench_area_outline_thickness thickness outline player bench area bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_area_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_area_fill","text":"data frame containing bounding coordinates player bench area's inner filling","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":null,"dir":"Reference","previous_headings":"","what":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"thickness boards, located outside field surface. bench's outline share color boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"","code":"lacrosse_player_bench_outline( bench_area_outline_thickness = 0, bench_length = 0, bench_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"bench_area_outline_thickness thickness outline player bench areas bench_length length player bench area bench_depth depth player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_player_bench_outline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The player benches are the areas outside the confines of the field where\nplayers not currently on the field are seated. They are to be on the same\nside of the field surface and separate, as close to center field as possible — lacrosse_player_bench_outline","text":"data frame containing bounding coordinates player bench area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":null,"dir":"Reference","previous_headings":"","what":"The referee's crease is a semi-circle on the ","title":"The referee's crease is a semi-circle on the ","text":"referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line) referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The referee's crease is a semi-circle on the ","text":"","code":"lacrosse_referee_crease(referee_crease_radius = 0, line_thickness = 0) lacrosse_referee_crease(referee_crease_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The referee's crease is a semi-circle on the ","text":"referee_crease_radius radius referee's crease line_thickness thickness draw referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The referee's crease is a semi-circle on the ","text":"data frame bounding coordinates referee's crease data frame bounding coordinates referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":null,"dir":"Reference","previous_headings":"","what":"The referee's crease is a semi-circle on the ","title":"The referee's crease is a semi-circle on the ","text":"referee's crease semi-circle \"bottom\" boards (TV view), centered line y = 0 (center center line). feature corresponds section field encloses","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The referee's crease is a semi-circle on the ","text":"","code":"lacrosse_referee_crease_fill(referee_crease_radius = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The referee's crease is a semi-circle on the ","text":"referee_crease_radius radius referee's crease line_thickness thickness draw referee's crease","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_referee_crease_fill.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The referee's crease is a semi-circle on the ","text":"data frame bounding coordinates referee's crease's enclosed area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"restraining line spans entire width field (present) connects defensive area lines (see lacrosse_defensive_area_line())","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"","code":"lacrosse_restraining_line(field_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"field_width width field line_thickness thickness restraining line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_restraining_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The restraining line spans the entire width of the field (where present) and\nconnects to the defensive area lines (see lacrosse_defensive_area_line()) — lacrosse_restraining_line","text":"data frame containing bounding coordinates restraining line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"sidelines run length field, interior edge designating -bounds area","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"","code":"lacrosse_sideline(field_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"field_length interior length field line_thickness thickness sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sidelines run the length of the field, with its interior edge designating\nthe in-bounds area — lacrosse_sideline","text":"data frame containing bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"wing lines run parallel sidelines cross center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"","code":"lacrosse_wing_line(wing_line_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"wing_line_length length wing line line_thickness thickness wing line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/lacrosse_wing_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The wing lines run parallel to the sidelines and cross the center line — lacrosse_wing_line","text":"data frame containing bounding coordinates wing line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":null,"dir":"Reference","previous_headings":"","what":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"Load default parameters specified league. used debugging package","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"","code":"load_default_parameters( league = \"\", display_range = \"full\", court_updates = list(), field_updates = list(), pitch_updates = list(), rink_updates = list(), sheet_updates = list(), color_updates = list(), rotation = 0, x_trans = 0, y_trans = 0, court_units = NULL, field_units = NULL, pitch_units = NULL, rink_units = NULL, sheet_units = NULL, xlims = NULL, ylims = NULL )"},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"league league load global environment display_range display range load global environment court_updates default court_updates load global environment. default empty list field_updates default field_updates load global environment. default empty list pitch_updates default pitch_updates load global environment. default empty list rink_updates default rink_updates load global environment. default empty list sheet_updates default sheet_updates load global environment. default empty list color_updates default color_updates load global environment. default empty list rotation default rotation load global environment. default 0 x_trans default translation x direction load global environment. default 0 y_trans default translation y direction load global environment. default 0 court_units default units court-like surface. default NULL field_units default units field-like surface. default NULL pitch_units default units pitch-like surface. default NULL rink_units default units rink-like surface. default NULL sheet_units default units sheet-like surface. default NULL xlims default limits plot use x direction. default NULL ylims default limits plot use y direction. default NULL","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/load_default_parameters.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load default parameters for a specified league. This should only be used when\ndebugging the package — load_default_parameters","text":"Nothing, environment variables set","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"Deploy quadratic formula given inputs , b, c satisfy equation (* (x ^ 2)) + bx + c = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"","code":"quadratic_formula(a, b, c)"},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"coefficient squared term b coefficient linear term c coefficient constant term","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/quadratic_formula.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Deploy the quadratic formula given inputs a, b, and c\nsuch that they satisfy the equation (a * (x ^ 2)) + bx + c = 0 — quadratic_formula","text":"solutions equation","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":null,"dir":"Reference","previous_headings":"","what":"Perform a mathematical reflection of coordinates over a specified axis — reflect","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"Perform mathematical reflection coordinates specified axis","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"","code":"reflect(df, over_x = FALSE, over_y = TRUE)"},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"df data frame reflect. must x y columns over_x boolean indicating whether reflect x axis. Default: FALSE over_y boolean indicating whether reflect y axis. Default: TRUE","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"reflected data frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/reflect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Perform a mathematical reflection of coordinates over a specified axis — reflect","text":"","code":"reflect(data.frame(x = 1, y = 0)) #> x y #> 1 -1 0"},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":null,"dir":"Reference","previous_headings":"","what":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"Perform mathematical rotation (0, 0) coordinates. rotation given x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\* cos(theta)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"","code":"rotate_coords(df, angle = 90)"},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"df data frame rotate. must x y columns angle angle (degrees) rotate coordinates","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"rotated data frame","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/rotate_coords.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Perform a mathematical rotation about (0, 0) of coordinates. This rotation is\ngiven as x' = x \\* cos(theta) - y \\* sin(theta) y' = x \\* sin(theta) + y \\*\ncos(theta) — rotate_coords","text":"","code":"rotate_coords(data.frame(x = 0, y = 1)) #> x y #> 1 -1 6.123234e-17"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":null,"dir":"Reference","previous_headings":"","what":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"","code":"soccer_center_circle(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"feature_radius outer radius center circle feature_thickness thickness center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_circle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center circle is the circle located at the center of the field. Inside of\nthe center circle is the center mark, where each half begins, as well as\nwhere play resumes following a goal — soccer_center_circle","text":"data frame containing bounding coordinates center circle","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"center mark kickoffs half, well following goal, taken. radius given outside mark. feature located midfield","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"","code":"soccer_center_mark(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"feature_radius radius center mark pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_center_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center mark is where kickoffs for each half, as well as following any\ngoal, are taken. The radius should be given to the outside of the mark. This\nfeature is located at midfield — soccer_center_mark","text":"data frame containing bounding coordinates center mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":null,"dir":"Reference","previous_headings":"","what":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"","code":"soccer_corner_arc(feature_radius = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"feature_radius outer radius corner arc feature_thickness thickness corner arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_arc.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The corner arcs are the quarter-circles located where the touchline meets the\ngoal line — soccer_corner_arc","text":"data frame containing bounding coordinates corner arc","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":null,"dir":"Reference","previous_headings":"","what":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"marks outside field play","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"","code":"soccer_corner_defensive_marks( feature_thickness = 0, is_touchline = FALSE, is_goal_line = FALSE, depth = 0, separation_from_line = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"feature_thickness thickness corner defensive marks is_touchline boolean indicating whether corner defensive marks along touchline is_goal_line boolean indicating whether corner defensive marks along goal line depth depth mark extends play separation_from_line distance back edge goal line interior edge corner defensive mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"data frame containing bounding coordinates corner defensive marks","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_corner_defensive_marks.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The corner defensive marks on the pitch are typically located 9.15 meters (10\nyards) from the corner of the pitch. Defenders should be beyond these marks\n(either more towards the goal or more towards the halfway line) during corner\nkicks — soccer_corner_defensive_marks","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"","code":"soccer_features_set_colors( plot_background = NULL, offensive_half_pitch = \"#195f0c\", defensive_half_pitch = \"#195f0c\", pitch_apron = \"#195f0c\", touchline = \"#ffffff\", goal_line = \"#ffffff\", corner_arc = \"#ffffff\", halfway_line = \"#ffffff\", center_circle = \"#ffffff\", center_mark = \"#ffffff\", penalty_box = \"#ffffff\", goal_box = \"#ffffff\", penalty_mark = \"#ffffff\", corner_defensive_mark = \"#ffffff\", goal = \"#ffffff\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"plot_background hexadecimal string representing color use feature touchline hexadecimal string representing color use feature goal_line hexadecimal string representing color use feature halfway_line hexadecimal string representing color use feature center_circle hexadecimal string representing color use feature center_mark hexadecimal string representing color use feature penalty_box hexadecimal string representing color use feature goal_box hexadecimal string representing color use feature penalty_mark hexadecimal string representing color use feature corner_defensive_mark hexadecimal string representing color use feature goal hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — soccer_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"","code":"soccer_goal(feature_thickness = 0, goal_width = 0, goal_depth = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"feature_thickness thickness goal goal_width interior width goal goal_depth depth goal protrudes away back edge goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal is located beyond each goal line. By rule, the goal posts must be\nthe same thickness as the goal line, and the posts must rest on the front\nedge of the goal line — soccer_goal","text":"data frame containing bounding coordinates goal","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"","code":"soccer_goal_box( feature_thickness = 0, box_length = 0, goal_width = 0, goal_post_to_box_edge = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"feature_thickness thickness goal box box_length length goal box (goal line) goal_width interior width goal goal_post_to_box_edge distance interior goal post outer edge goal box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal box is the smaller of the two boxes that extend from the goal line\nThe goal box is usually 5.5 meters (6 yards) from the goal line, but may be\nparameterized via this function — soccer_goal_box","text":"data frame containing bounding coordinates goal box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"","code":"soccer_goal_line(pitch_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"pitch_width width pitch feature_thickness thickness goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_goal_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The goal line is the line that runs the full width of the pitch. The ball\nmust completely cross the goal line to score a goal for the attacking team — soccer_goal_line","text":"data frame containing bounding coordinates goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":null,"dir":"Reference","previous_headings":"","what":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"Half pitch located side halfway line (see soccer_halfway_line() information)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"","code":"soccer_half_pitch(pitch_length = 0, pitch_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"pitch_length length pitch pitch_width width pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_half_pitch.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Half of the pitch is located on each side of the halfway line (see\nsoccer_halfway_line() for more information) — soccer_half_pitch","text":"data frame containing bounding coordinates half pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"","code":"soccer_halfway_line(pitch_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"pitch_width width pitch feature_thickness thickness goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_halfway_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The halfway line, aka the midfield line or center line, runs the width of the\npitch, dividing it into two equal halves. The left half (in TV view) will be\nthe defensive half, and the right half will be the offensive half — soccer_halfway_line","text":"data frame containing bounding coordinates halfway line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"draws half-box, include circular portion top box. dimensions given outside features","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"","code":"soccer_penalty_box( feature_radius = 0, feature_thickness = 0, box_length = 0, penalty_mark_dist = 0, goal_width = 0, goal_post_to_box_edge = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"feature_radius radius circle top penalty box feature_thickness thickness penalty box box_length length penalty box (goal line) penalty_mark_dist distance back edge goal line penalty mark goal_width interior width goal goal_post_to_box_edge distance interior goal post outer edge penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"data frame containing bounding coordinates penalty box","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_box.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The penalty box on the pitch is the larger of the two boxes that extend from\nthe goal line. The penalty box is usually 16.5 meters (18 yards) from the\ngoal line, but may be parameterized via this function — soccer_penalty_box","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"penalty mark center point arc penalty box, well penalty kick taken ","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"","code":"soccer_penalty_mark(feature_radius = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"feature_radius radius penalty mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_penalty_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The penalty mark is the center point for the arc of the penalty box, as well\nas where any penalty kick is taken from — soccer_penalty_mark","text":"data frame containing bounding coordinates penalty mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"Replicate spacing goal line/touchline nearest ad boards","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"","code":"soccer_pitch_apron( pitch_length = 0, pitch_width = 0, pitch_apron_touchline = 0, pitch_apron_goal_line = 0, goal_depth = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"pitch_length length pitch pitch_width width pitch pitch_apron_touchline distance beyond outer edge touchline pitch's apron extend pitch_apron_goal_line distance beyond outer edge back goal pitch's apron extend goal_depth depth goal protrudes away back edge goal line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"data frame containing bounding coordinates pitch's apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_pitch_apron.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"The pitch should have an apron around it to do two things: — soccer_pitch_apron","text":"Allow goal line touchline clearly visible makes practical sense, grass outside -play area pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"line thickness uniform features pitch","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"","code":"soccer_touchline(pitch_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"pitch_length length pitch feature_thickness thickness touchline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/soccer_touchline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines that run the full length of the pitch are called the touchlines. In\nsome cases, they may also be referred to as the sidelines, as they comprise\nthe sides of the pitch — soccer_touchline","text":"data frame containing bounding coordinates touchline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/surface_dimensions.html","id":null,"dir":"Reference","previous_headings":"","what":"surface_dimensions — surface_dimensions","title":"surface_dimensions — surface_dimensions","text":"list lists (JSON) associates league appropriate dimensions draw surface. data follows current dimensions specified rule books, can found rule book directory","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/surface_dimensions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"surface_dimensions — surface_dimensions","text":"set dimensions sport league","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":null,"dir":"Reference","previous_headings":"","what":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"backcourt area behind serviceline court, contained within singles sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"","code":"tennis_backcourt(court_length = 0, serviceline_distance = 0, singles_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"court_length length court serviceline_distance distance net serviceline singles_width width singles court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_backcourt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The backcourt is the area behind the serviceline on the court, contained\nwithin the singles sidelines — tennis_backcourt","text":"data frame containing bounding coordinates backcourt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":null,"dir":"Reference","previous_headings":"","what":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"baseline line behind player serve ball. spans entire width court, back edge denotes furthest boundary inside ball can land considered play","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"","code":"tennis_baseline(court_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"court_width width court feature_thickness thickness baseline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_baseline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The baseline is the line behind which a player will serve the ball. It spans\nthe entire width of the court, and its back edge denotes the furthest\nboundary inside of which a ball can land and be considered in play — tennis_baseline","text":"data frame containing bounding coordinates baseline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"center mark identifies center point tennis_baseline(). line extend towards net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"","code":"tennis_center_mark(center_mark_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"center_mark_length length center mark measured back edge baseline feature_thickness thickness center mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center mark identifies the center point of the\ntennis_baseline(). The line should extend towards the net — tennis_center_mark","text":"data frame containing bounding coordinates center mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":null,"dir":"Reference","previous_headings":"","what":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"line extends net back edge serviceline, centered line x = 0","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"","code":"tennis_center_serviceline(center_serviceline_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"center_serviceline_length length center serviceline net back edge serviceline (see tennis_serviceline() information) feature_thickness thickness center serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_center_serviceline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center serviceline on the court divides the service area into two parts:\nthe ad court (left) and the deuce court (right) — tennis_center_serviceline","text":"data frame containing bounding coordinates center serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"court apron referred backstop sidestop. areas entirely outside playing court, legal shots made considered play","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"","code":"tennis_court_apron( court_length = 0, court_width = 0, backstop_distance = 0, sidestop_distance = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"court_length length court court_width width court (usually doubles width court) backstop_distance distance back edge tennis_baseline() back boundary sidestop_distance distance outer edge tennis_sideline() side boundary","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_court_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The court apron is referred to as the backstop and sidestop. These areas are\nentirely outside of the playing court, but legal shots made here are\nconsidered in play — tennis_court_apron","text":"data frame containing bounding coordinates court apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":null,"dir":"Reference","previous_headings":"","what":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"doubles alley area singles doubles sideline. run entire length court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"","code":"tennis_doubles_alley(court_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"court_length length court feature_thickness thickness doubles alley (distance singles doubles sidelines)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_doubles_alley.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The doubles alley is the area between the singles and doubles sideline. It\nshould run the entire length of the court — tennis_doubles_alley","text":"data frame containing bounding coordinates doubles alley","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"","code":"tennis_features_set_colors( plot_background = NULL, baseline = \"#ffffff\", singles_sideline = \"#ffffff\", doubles_sideline = \"#ffffff\", serviceline = \"#ffffff\", center_serviceline = \"#ffffff\", center_mark = \"#ffffff\", ad_court = \"#395d33\", deuce_court = \"#395d33\", backcourt = \"#395d33\", doubles_alley = \"#395d33\", court_apron = \"#395d33\", net = \"#d3d3d3\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"plot_background hexadecimal string representing color use feature baseline hexadecimal string representing color use feature singles_sideline hexadecimal string representing color use feature doubles_sideline hexadecimal string representing color use feature serviceline hexadecimal string representing color use feature center_serviceline hexadecimal string representing color use feature center_mark hexadecimal string representing color use feature ad_court hexadecimal string representing color use feature deuce_court hexadecimal string representing color use feature backcourt hexadecimal string representing color use feature doubles_alley hexadecimal string representing color use feature court_apron hexadecimal string representing color use feature net hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — tennis_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":null,"dir":"Reference","previous_headings":"","what":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"one half front court (either ad deuce court)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"","code":"tennis_frontcourt_half(serviceline_distance = 0, singles_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"serviceline_distance distance net serviceline singles_width width singles court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_frontcourt_half.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The front court is the area between the tennis_net() and the\ntennis_serviceline(). left-hand side of the court when facing the net from\nthe nearest baseline is the ad court, and the right-hand side is the deuce\ncourt. This is constrained by the singles tennis_sideline(). — tennis_frontcourt_half","text":"data frame containing bounding coordinates one half frontcourt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":null,"dir":"Reference","previous_headings":"","what":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"net divides court two halves, run line x = 0 viewing court TV view","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"","code":"tennis_net(feature_thickness = 0, net_length = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"feature_thickness thickness net net_length length net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_net.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The net divides the court into two halves, and should run through the line\nx = 0 when viewing the court in TV view — tennis_net","text":"data frame containing bounding coordinates net","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":null,"dir":"Reference","previous_headings":"","what":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"line extends completely singles sidelines (extend doubles sidelines)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"","code":"tennis_serviceline(singles_width = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"singles_width width singles court feature_thickness thickness serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_serviceline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The serviceline is the line in front of which (nearest the net) a serve must\nland, and be on the proper side of the court to be considered legal and in\nplay — tennis_serviceline","text":"data frame containing bounding coordinates serviceline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"sideline runs entire length court, may four sidelines court (may refer either singles doubles sideline). Lines considered play, outer edge sideline lie along x = court_width / 2","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"","code":"tennis_sideline(court_length = 0, feature_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"court_length length court feature_thickness thickness sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/tennis_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The sideline runs the entire length of the court, and there may be up to four\nsidelines on the court (this may refer to either the singles or doubles\nsideline). Lines are considered in play, so the outer edge of the sideline\nwill lie along x = court_width / 2 — tennis_sideline","text":"data frame containing bounding coordinates sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"attack line runs sideline sideline separating court's backcourt (volleyball_backcourt()) front zone (volleyball_front_zone()). Players front row may attack either side line, players back row must begin attack backcourt side line. anchor point feature outer edge","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"","code":"volleyball_attack_line(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"court_width width court, measured exterior edges sidelines line_thickness thickness attack line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_attack_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The attack line runs from sideline to sideline separating the court's\nbackcourt (volleyball_backcourt()) from the front zone\n(volleyball_front_zone()). Players in the front row may attack from either\nside of this line, while players in the back row must begin their attack from\nthe backcourt side of the line. The anchor point of this feature should be\nits outer edge — volleyball_attack_line","text":"data frame containing bounding box attack line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":null,"dir":"Reference","previous_headings":"","what":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"backcourt area attack line (see volleyball_attack_line()) end line (see volleyball_end_line()). Players playing back row rotation must take area attacking ball. considering entirety volleyball court divided thirds, either outer thirds court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"","code":"volleyball_backcourt( attack_line_edge_to_center_line = 0, court_length = 0, court_width = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"attack_line_edge_to_center_line distance edge furthest attack line center line running along x = 0 court_length length court, measured exterior edges end lines court_width width court, measured exterior edges sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_backcourt.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The backcourt is the area between the the attack line (see\nvolleyball_attack_line()) and the end line (see volleyball_end_line()).\nPlayers playing in the back row of the rotation must take off from this area\nbefore attacking the ball. If considering the entirety of the volleyball\ncourt as being divided into thirds, this is either of the outer thirds of\nthe court — volleyball_backcourt","text":"data frame containing bounding coordinates backcourt","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"center line's axis runs along x = 0 viewing court TV view, dividing court two equal halves","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"","code":"volleyball_center_line(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"court_width width court, measured exterior edges sidelines line_thickness thickness center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_center_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The center line's axis runs along x = 0 when viewing the court in TV\nview, dividing the court into two equal halves — volleyball_center_line","text":"data frame containing bounding box center line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":null,"dir":"Reference","previous_headings":"","what":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"court apron similar basketball_court_apron() area outside court. may color interior court, necessarily. Unlike basketball_court_apron() however, boundary line thickness matter since lines considered -play therefore included court's length width. colored area inside free zone (see volleyball_free_zone()).","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"","code":"volleyball_court_apron( court_length = 0, court_width = 0, court_apron_end_line = 0, court_apron_sideline = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"court_length length court, measured exterior edges end lines court_width width court, measured exterior edges sidelines court_apron_end_line distance court apron extends beyond outer edge end line court_apron_sideline distance court apron extends beyond outer edge sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_court_apron.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The court apron is similar to the basketball_court_apron() in that it is\nthe area outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is a colored\narea inside of the free zone (see volleyball_free_zone()). — volleyball_court_apron","text":"data frame containing bounding coordinates court apron","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"lines court run full width court referred end lines, full width line considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"","code":"volleyball_end_line(court_width = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"court_width width court, measured exterior edges sidelines line_thickness thickness end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_end_line.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines on the court that run the full width of the court are referred to\nas the end lines, with the full width of the line being considered in bounds — volleyball_end_line","text":"data frame containing bounding box end line","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"Hexadecimal values passed vales function default, also possible use string-named values (e.g. \"dodgerblue\") specifying.","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"","code":"volleyball_features_set_colors( plot_background = NULL, free_zone = \"#d2ab6f\", front_zone = \"#d2ab6f\", defensive_backcourt = \"#d2ab6f\", offensive_backcourt = \"#d2ab6f\", court_apron = \"#d2ab6f\", end_line = \"#000000\", sideline = \"#000000\", attack_line = \"#000000\", center_line = \"#000000\", service_zone_mark = \"#000000\", substitution_zone = \"#000000\" )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"plot_background hexadecimal string representing color use feature free_zone hexadecimal string representing color use feature front_zone hexadecimal string representing color use feature defensive_backcourt hexadecimal string representing color use feature offensive_backcourt hexadecimal string representing color use feature court_apron hexadecimal string representing color use feature end_line hexadecimal string representing color use feature sideline hexadecimal string representing color use feature attack_line hexadecimal string representing color use feature center_line hexadecimal string representing color use feature service_zone_mark hexadecimal string representing color use feature substitution_zone hexadecimal string representing color use feature","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_features_set_colors.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the colors to be used for the plot. The values provided in the arguments\nare the defaults, and, where specified, are the rule-book specified values. — volleyball_features_set_colors","text":"list hexadecimal colors use color features resulting plot","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"free zone similar basketball_court_apron() area outside court. may color interior court, necessarily. Unlike basketball_court_apron() however, boundary line thickness matter since lines considered -play therefore included court's length width. volleyball_court_apron(), entire area outside court's lines, court apron corresponds colored apron inside free zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"","code":"volleyball_free_zone( court_length = 0, court_width = 0, free_zone_end_line = 0, free_zone_sideline = 0 )"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"court_length length court, measured exterior edges end lines court_width width court, measured exterior edges sidelines free_zone_end_line distance free zone extends beyond outer edge end line free_zone_sideline distance free zone extends beyond outer edge sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_free_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The free zone is similar to the basketball_court_apron() in that it is the\narea outside the court. It may be the same color as the interior of the\ncourt, but isn't necessarily. Unlike basketball_court_apron() however, the\nboundary line thickness doesn't matter since the lines are considered in-play\nand therefore are included in the court's length and width. This is not the\nsame as the volleyball_court_apron(), as this is the entire area outside of\nthe court's lines, while the court apron corresponds to a colored apron\ninside the free zone — volleyball_free_zone","text":"data frame containing bounding coordinates free zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":null,"dir":"Reference","previous_headings":"","what":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"front zone area attack line (see volleyball_attack_line()) line running along x = 0. considering entirety volleyball court divided thirds, half middle third court","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"","code":"volleyball_front_zone(attack_line_edge_to_center_line = 0, court_width = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"attack_line_edge_to_center_line distance edge furthest attack line center line running along x = 0 court_width width court, measured exterior edges sidelines","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_front_zone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The front zone is the area between the attack line (see\nvolleyball_attack_line()) and the line running along x = 0. If\nconsidering the entirety of the volleyball court as being divided into\nthirds, this is half of the middle third of the court — volleyball_front_zone","text":"data frame containing bounding coordinates center zone","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":null,"dir":"Reference","previous_headings":"","what":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"service zone marks lines beyond end lines denote legal serve must take place. appear four hash marks bounds court, contained within free zone (see volleyball_free_zone() reference)","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"","code":"volleyball_service_zone_mark(service_zone_mark_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"service_zone_mark_length distance service zone mark extends away outer edge end line line_thickness thickness service zone marks","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_service_zone_mark.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The service zone marks are the lines beyond the end lines that denote where a\nlegal serve must take place. These appear as four hash marks that are out of\nbounds of the court, but contained within the free zone (see\nvolleyball_free_zone() for reference) — volleyball_service_zone_mark","text":"data frame containing bounding box service zone mark","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":null,"dir":"Reference","previous_headings":"","what":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"lines court run full length court referred sidelines, full width line considered bounds","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"","code":"volleyball_sideline(court_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"court_length length court, measured exterior edges end lines line_thickness thickness sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_sideline.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The lines on the court that run the full length of the court are referred to\nas the sidelines, with the full width of the line being considered in bounds — volleyball_sideline","text":"data frame containing bounding box sideline","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":null,"dir":"Reference","previous_headings":"","what":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"substitution zone typically marked dashed line extending attack lines (see volleyball_attack_line() ). creates single dash, dashes added plot accordingly","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"","code":"volleyball_substitution_zone_dash(dash_length = 0, line_thickness = 0)"},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"dash_length length dash draw line_thickness thickness substitution zone dashes","code":""},{"path":"https://sportyR.sportsdataverse.org/reference/volleyball_substitution_zone_dash.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The substitution zone is typically marked by a dashed line extending from the\nattack lines (see volleyball_attack_line() for more). This creates a single\ndash, and the dashes should be added to the plot accordingly — volleyball_substitution_zone_dash","text":"data frame containing bounding box single dash substitution zone","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-222","dir":"Changelog","previous_headings":"","what":"sportyR 2.2.2","title":"sportyR 2.2.2","text":"Fixed #32 plot titles displaying correctly Updating documentation per CRAN notes r-devel","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-221","dir":"Changelog","previous_headings":"","what":"sportyR 2.2.1","title":"sportyR 2.2.1","text":"CRAN release: 2023-06-15 Faceting ggplot2 now works expected (#27, @mrcaseb) Fixed link vignette point POSIT, RStudio","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"patchesbug-fixes-2-2-0","dir":"Changelog","previous_headings":"","what":"Patches/Bug Fixes","title":"sportyR 2.2.0","text":"Fixed #24. Invalid league errors now explicit","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"changes-to-existing-sports-2-2-0","dir":"Changelog","previous_headings":"","what":"Changes to Existing Sports","title":"sportyR 2.2.0","text":"MLB MiLB bases now 18” default per 2023 rules change","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"lacrosse-2-2-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Lacrosse","title":"sportyR 2.2.0","text":"National Lacrosse League NCAA Men’s Lacrosse NCAA Women’s Lacrosse Premier Lacrosse League USA Men’s Lacrosse USA Women’s Lacrosse World Lacrosse","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"internal-changes-2-2-0","dir":"Changelog","previous_headings":"","what":"Internal Changes","title":"sportyR 2.2.0","text":"Re-aligned switch() statements condition cases matching indentation improve readability Updated syntax geom_football() avoid tidy syntax deprecation warning Added load_default_parameters() function faster debugging internally. function allows defaults particular geom_{sport}() function loaded set environment variables rather set one individually Updated data-raw/internal-datasets.R clear environment reload current version package upon sourcing debugging","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-210","dir":"Changelog","previous_headings":"","what":"sportyR 2.1.0","title":"sportyR 2.1.0","text":"CRAN release: 2022-10-31","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"patchesbug-fixes-2-1-0","dir":"Changelog","previous_headings":"","what":"Patches/Bug Fixes","title":"sportyR 2.1.0","text":"Fixed #14. Issue volleyball documentation Fixed #15. outline colors respected Added red zone border border outline football fields Changed default coloring football field border outline Fixed issue field border thickness plotting behind bench Fixed #18. Can now constrain plots display -bound playing area (plus sidelines) Corrected football field layering work better hex-alpha color specifications (layering colors previously caused issues)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"internal-changes-2-1-0","dir":"Changelog","previous_headings":"","what":"Internal Changes","title":"sportyR 2.1.0","text":"Renamed files use - (hyphen) instead _ (underscore) across package New function, is_hex(), checks value valid hexadecimal (relates #15) Animating Tracking Data vignette now uses images hosted GitHub avoid need render run time","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"volleyball-2-1-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Volleyball","title":"sportyR 2.1.0","text":"FIVB NCAA USA Volleyball","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"curling-2-1-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Curling","title":"sportyR 2.1.0","text":"Curling Canada","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-201","dir":"Changelog","previous_headings":"","what":"sportyR 2.0.1","title":"sportyR 2.0.1","text":"CRAN release: 2022-09-24","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"patchesbug-fixes-2-0-1","dir":"Changelog","previous_headings":"","what":"Patches/Bug Fixes","title":"sportyR 2.0.1","text":"Fixed #8. display ranges hockey rinks work expected Fixed #9. Yardage markers now move responsive x_trans y_trans Added gifski package Suggests-level dependency gifs vignettes may render properly","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"intenal-changes-2-0-1","dir":"Changelog","previous_headings":"","what":"Intenal Changes","title":"sportyR 2.0.1","text":"Changed logic curling ends drawn/placed curling sheet Adjusted xlims geom_hockey() include slightly neutral zone using display_range %% c(\"ozone\", \"dzone\") Updated licensing GPL >= 3 Changed website colors","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-200","dir":"Changelog","previous_headings":"","what":"sportyR 2.0.0","title":"sportyR 2.0.0","text":"CRAN release: 2022-08-15","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"internal-changes-2-0-0","dir":"Changelog","previous_headings":"","what":"Internal Changes","title":"sportyR 2.0.0","text":"Re-defined surfaces parameterized size features, rather defined individually file New internal data set (data-raw/surface_dimensions.json) maintain league dimensions Removal data-raw/sport_lookup.json data-raw/league_lookup.json files (replaced data-raw/surface_dimensions.json) Updated styling conventions match tidyverse style guide sole exception use explicit return() statements Updated file naming convention easier group feature files geom_{sport}() files Updated documentation","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"additional-capabilities-2-0-0","dir":"Changelog","previous_headings":"","what":"Additional Capabilities","title":"sportyR 2.0.0","text":"Introduction display_range parameter allow customized views plots (e.g. seeing red zone football field, rather entire field) Introduction {surface}_updates parameter allow customization surface starting base surface (e.g. geom_hockey(\"NHL\", surface_updates = list(rink_length = 400))) create regulation NHL ice rink twice long . allows package better handle edge cases support users bat less internal maintenance Introduction color_updates parameter allow colors features change easily explicitly internally code Introduction x_trans y_trans argument every surface adjust positioning origin","code":""},{"path":[]},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"baseball-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Baseball","title":"sportyR 2.0.0","text":"MiLB Little League NCAA NFHS (high school) Pony","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"basketball-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Basketball","title":"sportyR 2.0.0","text":"NBA G League NFHS (high school)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"curling-new-supported-sport-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Curling (New Supported Sport)","title":"sportyR 2.0.0","text":"WCF (World Curling Federation)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"hockey-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Hockey","title":"sportyR 2.0.0","text":"AHL ECHL OHL QMJHL USHL","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"football-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Football","title":"sportyR 2.0.0","text":"NFHS 11-player NFHS 9-player NFHS 8-player NFHS 6-player","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"tennis-2-0-0","dir":"Changelog","previous_headings":"New Sports and Leagues Supported","what":"Tennis","title":"sportyR 2.0.0","text":"ATP ITA USTA WTA","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"breaking-changes-and-justifications-for-breaks-2-0-0","dir":"Changelog","previous_headings":"","what":"Breaking Changes (and justifications for breaks)","title":"sportyR 2.0.0","text":"Removed full_surf rotation_dir arguments allow display_range flexible rotation arguments introduced. improved argument structure allow granular “zoom” plots regions interest, well adjusting coordinates appropriately match data sets Removed vdiffr tests becoming unmanageable didn’t scale well new leagues. Additionally, league change dimension requirements, case longer valid despite league’s plot requiring change. Instead, individual plotting functions checked well classes resulting plots","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-104","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.4","title":"sportyR 1.0.4","text":"Removed requirement include plot caption color (fixes #3) September 7, 2021, NWHL changed names PHF. name change now reflected package, NWHL still valid backwards compatible.","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-103","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.3","title":"sportyR 1.0.3","text":"Added tennis plotting capability Fixed issue NCAA football plot hash marks (initially typed 6, typed 60) Fixed minor bug soccer plots (changed rotation_dir = TRUE rotation_dir = \"ccw\") Fixed minor bug NCAA hockey plots plotting units ft (reordered geom_ncaa_hockey() code adjust units plotting) Restructured code tests/testthat/test-plot-functions.R closely resemble rest repository structure. Plots now tested sport rather plot-specific feature (e.g. units rotation) Fixed minor bug converting millimeters feet (originally specified 3048mm per foot, corrected 304.8mm per foot)","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-102","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.2","title":"sportyR 1.0.2","text":"Added CFL plotting capability","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-101","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.1","title":"sportyR 1.0.1","text":"CRAN release: 2021-04-20 Introduced new testing infrastructure","code":""},{"path":"https://sportyR.sportsdataverse.org/news/index.html","id":"sportyr-100","dir":"Changelog","previous_headings":"","what":"sportyR 1.0.0","title":"sportyR 1.0.0","text":"CRAN release: 2021-04-19 Initial release! Ability plot baseball, basketball ((W)NBA, NCAA, FIBA), football (NFL NCAA), hockey ((W)NHL, IIHF, NCAA), soccer (FIFA, MLS, NCAA, NWSL, Premier League) included, capability customize outputs specific colors.","code":""}]