From c4f576daa567d9f0d52fb942b73e7995510a21a3 Mon Sep 17 00:00:00 2001 From: Torvaney Date: Sun, 6 Oct 2024 21:39:40 +0000 Subject: [PATCH] Update documentation --- man/pitch_opta.Rd | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/man/pitch_opta.Rd b/man/pitch_opta.Rd index e3d7144..c2e8f0f 100644 --- a/man/pitch_opta.Rd +++ b/man/pitch_opta.Rd @@ -51,30 +51,29 @@ However, user-defined specifications can also be used. \details{ A "pitch specification" is simply a list of dimensions that define a coordinate system. The required dimensions are: - \itemize{ -\item{"length"}{The length of the pitch from one goal to the other (x axis)} -\item{"width"}{The width of the pitch from touchline to the other (y axis)} -\item{"penalty_box_length"}{The distance from the goalline to the edge of the penalty area} -\item{"penalty_box_width"}{The width of the penalty area} -\item{"six_yard_box_length"}{The distance from the goalline to the edge of the six-yard box} -\item{"six_yard_box_width"}{The width of the six-yard box} -\item{"penalty_spot_distance"}{The distance from the goalline to the penalty spot} -\item{"goal_width"}{The distance from one goal post to the other} -\item{"origin_x"}{The minimum x coordinate of the pitch} -\item{"origin_y"}{The minimum y coordinate of the pitch} -\item{"penalty_arc_radius"}{The radius of the arc above the penalty box (Optional). Defaults to \code{penalty_spot_distance}} +\item "length": The length of the pitch from one goal to the other (x axis) +\item "width": The width of the pitch from touchline to the other (y axis) +\item "penalty_box_length": The distance from the goalline to the edge of the penalty area +\item "penalty_box_width": The width of the penalty area +\item "six_yard_box_length": The distance from the goalline to the edge of the six-yard box +\item "six_yard_box_width": The width of the six-yard box +\item "penalty_spot_distance": The distance from the goalline to the penalty spot +\item "goal_width": The distance from one goal post to the other +\item "origin_x": The minimum x coordinate of the pitch +\item "origin_y": The minimum y coordinate of the pitch +\item "penalty_arc_radius": The radius of the arc above the penalty box (Optional). Defaults to \code{penalty_spot_distance} } -The following pitch dimensions are provided +The following pitch dimensions are provided: \itemize{ -\item{"pitch_statsperform"}{For StatsPerform/Opts f24 data} -\item{"pitch_opta"}{Alias for "pitch_statsperform"} -\item{"pitch_statsbomb"}{For Statsbomb data} -\item{"pitch_wyscout"}{For Wyscout data} -\item{"pitch_international"}{As per UEFA Category 4 stadium regulations} -\item{"pitch_tracab"}{"For ChyronHego Tracab, using the 105m x 68m default size"} -\item{"pitch_impect"}{For IMPECT data} +\item "pitch_statsperform": For StatsPerform/Opta f24 data +\item "pitch_opta": Alias for "pitch_statsperform" +\item "pitch_statsbomb": For Statsbomb data +\item "pitch_wyscout": For Wyscout data +\item "pitch_international": As per UEFA Category 4 stadium regulations +\item "pitch_tracab": "For ChyronHego Tracab, using the 105m x 68m default size" +\item "pitch_impect": For IMPECT data } } \examples{