Updating documentation per CRAN comments on r-devel

R/features-basketball.R

@@ -107,7 +107,7 @@ basketball_two_point_range <- function(basket_center_to_baseline = 0,
 #' the court coloring inside of the inner edge of this circle
 #'
 #' @param center_circle_radius The outer radius of the center circle
-#' @param linethickness The thickness of the line that comprises the center
+#' @param line_thickness The thickness of the line that comprises the center
 #'   circle
 #'
 #' @return A data frame of the boundary of the center circle. The interior of
@@ -138,8 +138,8 @@ basketball_center_circle_fill <- function(center_circle_radius = 0,
 #' @param lane_width The width of the free throw
 #' @param paint_margin The distance from the painted area of the lane to the
 #'   free throw lane boundary lines
-#' @param free_throw_lane_boundary_line_thickness The thickness of the line of
-#'   the free throw lane
+#' @param line_thickness The thickness of the line of the free throw lane
+#'   boundary line
 #'
 #' @return A data frame of the bounding coordinates of the free throw lane's
 #'   painted area
@@ -552,7 +552,7 @@ basketball_free_throw_circle <- function(overhang = 0,
 #' @param line_thickness The thickness of the dash
 #' @param start_angle The angle, in \code{radians / pi}, at which the dash
 #'   should start
-#' @param end_angleThe angle, in \code{radians / pi}, at which the dash should
+#' @param end_angle The angle, in \code{radians / pi}, at which the dash should
 #'   end
 #'
 #' @returns A data frame containing the bounding coordinates of a dash on the

R/features-football.R

@@ -370,7 +370,7 @@ football_sideline <- function(feature_thickness = 0,
 #' @param field_width The width of the field
 #' @param feature_thickness The thickness of the field border
 #' @param endzone_length The length of the endzone
-#' @param boundary_thickness The thickness of the boundary lines
+#' @param boundary_line_thickness The thickness of the boundary lines
 #' @param restricted_area_length The length of the restricted area
 #' @param restricted_area_width The width of the restricted area
 #' @param coaching_box_length The length of the coaching box
@@ -570,7 +570,7 @@ football_field_border <- function(field_length = 0,
 #' @param field_width The width of the field
 #' @param feature_thickness The thickness of the field border's outline
 #' @param endzone_length The length of the endzone
-#' @param boundary_thickness The thickness of the boundary lines
+#' @param boundary_line_thickness The thickness of the boundary lines
 #' @param restricted_area_length The length of the restricted area
 #' @param restricted_area_width The width of the restricted area
 #' @param coaching_box_length The length of the coaching box

R/features-hockey.R

@@ -468,7 +468,7 @@ hockey_goal_line <- function(rink_length = 0,
 #' by 'minor_line_thickness' as this is a minor line on the ice surface
 #'
 #' NOTE: This is not a requirement in all leagues, and may be omitted via the
-#' "has_trapezoid" key in the \code{rink_params} passed to geom_{league}
+#' "has_trapezoid" key in the \code{rink_params} passed to \code{geom_{league}}
 #'
 #' This draws the goaltender's restricted area on the right side (in TV view) of
 #' the ice surface. The figure is composed of lines that outline a trapezoid in

R/features-lacrosse.R

@@ -1283,11 +1283,12 @@ lacrosse_player_bench_area_fill <- function(bench_area_outline_thickness = 0,
 #' the field surface. Each penalty box's outline will share the same color as
 #' the boards
 #'
-#' @param feature_thickness The thickness of the outline of the penalty box
+#' @param penalty_box_outline_thickness The thickness of the outline of the penalty box
 #' @param penalty_box_length The length of the penalty box
+#' @param penalty_box_width The width of the penalty box
+#' @param penalty_box_separation The separation between the two penalty boxes
 #' @param penalty_box_depth The depth at which the penalty box extends from the
 #'   outer edge of the boards
-#' @param penalty_box_separation The separation between the two penalty boxes
 #'
 #' @return A data frame containing the bounding coordinates of the penalty box
 #'
@@ -1369,7 +1370,7 @@ lacrosse_penalty_box_fill <- function(penalty_box_outline_thickness = 0,
 #' This will have the same thickness as the boards, but will be located outside
 #' the field surface
 #'
-#' @param feature_thickness The thickness of the outline of the off-field
+#' @param officials_box_thickness The thickness of the outline of the off-field
 #'   officials' box
 #' @param officials_box_length The length of the off-field officials' box
 #' @param officials_box_depth The depth at which the off-field officials' box

R/geom-curling.R

@@ -7,7 +7,11 @@
 #'
 #' @param plot_background A hexadecimal string representing the color to use for
 #'   this feature
-#' @param sheet A hexadecimal string representing the color to use for this
+#' @param end_1 A hexadecimal string representing the color to use for this
+#'   feature
+#' @param center_zone A hexadecimal string representing the color to use for
+#'   this feature
+#' @param end_2 A hexadecimal string representing the color to use for this
 #'   feature
 #' @param sheet_apron A hexadecimal string representing the color to use for
 #'   this feature
@@ -27,12 +31,8 @@
 #'   feature
 #' @param button A hexadecimal string representing the color to use for this
 #'   feature
-#' @param ring_1 A hexadecimal string representing the color to use for this
-#'   feature
-#' @param ring_2 A hexadecimal string representing the color to use for this
-#'   feature
-#' @param ring_3 A hexadecimal string representing the color to use for this
-#'   feature
+#' @param house_rings A vector of hexadecimal strings representing the color(s)
+#'   to use for this feature
 #'
 #' @return A list of hexadecimal colors to use to color the features on the
 #'   resulting plot

R/geom-hockey.R

@@ -7,38 +7,54 @@
 #'
 #' @param plot_background A hexadecimal string representing the color to use for
 #'   this feature
-#' @param boards_color A hexadecimal string representing the color to use for
+#' @param boards A hexadecimal string representing the color to use for this
+#'   feature
+#' @param ozone_ice A hexadecimal string representing the color to use for this
+#'   feature
+#' @param nzone_ice A hexadecimal string representing the color to use for this
+#'   feature
+#' @param dzone_ice A hexadecimal string representing the color to use for this
+#'   feature
+#' @param center_line A hexadecimal string representing the color to use for
 #'   this feature
-#' @param center_line_color A hexadecimal string representing the color to use
+#' @param zone_line A hexadecimal string representing the color to use for this
+#'   feature
+#' @param goal_line A hexadecimal string representing the color to use for this
+#'   feature
+#' @param restricted_trapezoid A hexadecimal string representing the color to
+#'   use for this feature
+#' @param goal_crease_outline A hexadecimal string representing the color to use
 #'   for this feature
-#' @param blue_line_color A hexadecimal string representing the color to use for
-#'   this feature
-#' @param goal_line_color A hexadecimal string representing the color to use for
+#' @param goal_crease_fill A hexadecimal string representing the color to use
+#'   for this feature
+#' @param referee_crease A hexadecimal string representing the color to use for
 #'   this feature
-#' @param goalkeepers_restricted_area_color A hexadecimal string representing
-#'   the color to use for this feature
-#' @param goal_crease_outline_color A hexadecimal string representing the color
-#'   to use for this feature
-#' @param goal_crease_fill_color A hexadecimal string representing the color to
-#'   use for this feature
-#' @param referee_crease_color A hexadecimal string representing the color to
+#' @param center_faceoff_spot A hexadecimal string representing the color to use
+#'   for this feature
+#' @param faceoff_spot_ring A hexadecimal string representing the color to use
+#'   for this feature
+#' @param faceoff_spot_stripe A hexadecimal string representing the color to use
+#'   for this feature
+#' @param center_faceoff_circle A hexadecimal string representing the color to
 #'   use for this feature
-#' @param center_faceoff_spot_color A hexadecimal string representing the color
-#'   to use for this feature
-#' @param faceoff_spot_outer_ring_color A hexadecimal string representing the
-#'   color to use for this feature
-#' @param faceoff_spot_fill_color A hexadecimal string representing the color to
+#' @param odzone_faceoff_circle A hexadecimal string representing the color to
 #'   use for this feature
-#' @param center_faceoff_circle_color A hexadecimal string representing the
-#'   color to use for this feature
-#' @param non_center_faceoff_circle_color A hexadecimal string representing the
-#'   color to use for this feature
-#' @param faceoff_line_color A hexadecimal string representing the color to use
-#'   for this feature
-#' @param goal_color A hexadecimal string representing the color to use for this
+#' @param faceoff_line A hexadecimal string representing the color to use for
+#'   this feature
+#' @param goal_frame A hexadecimal string representing the color to use for this
 #'   feature
-#' @param goal_fill_color A hexadecimal string representing the color to use for
+#' @param goal_fill A hexadecimal string representing the color to use for this
+#'   feature
+#' @param team_a_bench A hexadecimal string representing the color to use for
+#'   this feature
+#' @param team_b_bench A hexadecimal string representing the color to use for
 #'   this feature
+#' @param team_a_penalty_box A hexadecimal string representing the color to use
+#'   for this feature
+#' @param team_b_penalty_box A hexadecimal string representing the color to use
+#'   for this feature
+#' @param off_ice_officials_box A hexadecimal string representing the color to
+#'   use for this feature
 #'
 #' @return A list of hexadecimal colors to use to color the features on the
 #'   resulting plot