diff --git a/R/dimensions.R b/R/dimensions.R index a607796..60d4a42 100644 --- a/R/dimensions.R +++ b/R/dimensions.R @@ -9,31 +9,26 @@ #' #' @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 `penalty_spot_distance`} -#' } -#' -#' 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} -#' } +#' * "length": The length of the pitch from one goal to the other (x axis) +#' * "width": The width of the pitch from touchline to the other (y axis) +#' * "penalty_box_length": The distance from the goalline to the edge of the penalty area +#' * "penalty_box_width": The width of the penalty area +#' * "six_yard_box_length": The distance from the goalline to the edge of the six-yard box +#' * "six_yard_box_width": The width of the six-yard box +#' * "penalty_spot_distance": The distance from the goalline to the penalty spot +#' * "goal_width": The distance from one goal post to the other +#' * "origin_x": The minimum x coordinate of the pitch +#' * "origin_y": The minimum y coordinate of the pitch +#' * "penalty_arc_radius": The radius of the arc above the penalty box (Optional). Defaults to `penalty_spot_distance` +#' +#' The following pitch dimensions are provided: +#' * "pitch_statsperform": For StatsPerform/Opta f24 data +#' * "pitch_opta": Alias for "pitch_statsperform" +#' * "pitch_statsbomb": For Statsbomb data +#' * "pitch_wyscout": For Wyscout data +#' * "pitch_international": As per UEFA Category 4 stadium regulations +#' * "pitch_tracab": "For ChyronHego Tracab, using the 105m x 68m default size" +#' * "pitch_impect": For IMPECT data #' #' @examples #' library(ggplot2)