Changelog
Source:NEWS.md
sportyR 2.2.2
- Fixed #32 with plot titles not displaying correctly
- Updating documentation per CRAN notes on
r-devel
sportyR 2.2.0
Patches/Bug Fixes
- Fixed #24. Invalid league errors should now be more explicit
Internal Changes
Re-aligned
switch()
statements to have condition and cases with matching indentation to improve readabilityUpdated syntax in
geom_football()
to avoid tidy syntax deprecation warningAdded
load_default_parameters()
function for faster debugging internally. This function allows all defaults of a particulargeom_{sport}()
function to be loaded and set as environment variables rather than having to set each one individuallyUpdated
data-raw/internal-datasets.R
to clear environment and reload current version of package upon sourcing for debugging
sportyR 2.1.0
CRAN release: 2022-10-31
Patches/Bug Fixes
Fixed #14. Issue with volleyball documentation
Fixed #15. All outline colors are respected
Added red zone border and border outline to football fields
Changed default coloring of football field border outline
Fixed issue with field border thickness when plotting behind the bench
Fixed #18. Can now constrain all plots to only display in-bound playing area (plus sidelines)
Corrected football field layering to work better with hex-alpha color specifications (layering of colors previously caused issues)
Internal Changes
Renamed files to use
-
(hyphen) instead of_
(underscore) across packageNew function,
is_hex()
, checks if a value is valid hexadecimal (relates to #15)Animating Tracking Data vignette now uses images hosted on GitHub to avoid the need to render at run time
sportyR 2.0.1
CRAN release: 2022-09-24
Intenal Changes
Changed logic into how curling ends are drawn/placed on a curling sheet
Adjusted
xlims
forgeom_hockey()
to include slightly more of the neutral zone when usingdisplay_range %in% c("ozone", "dzone")
Updated licensing to GPL >= 3
Changed website colors
sportyR 2.0.0
CRAN release: 2022-08-15
Internal Changes
Re-defined all surfaces to be parameterized by the size of their features, rather than being defined individually in a file
New internal data set (
data-raw/surface_dimensions.json
) to maintain all league dimensionsRemoval of
data-raw/sport_lookup.json
anddata-raw/league_lookup.json
files (replaced bydata-raw/surface_dimensions.json
)Updated styling conventions to match tidyverse style guide with the sole exception being the use of explicit
return()
statementsUpdated file naming convention to be easier to group feature files and
geom_{sport}()
filesUpdated documentation
Additional Capabilities
Introduction of the
display_range
parameter to allow customized views of plots (e.g. only seeing the red zone of a football field, rather than the entire field)Introduction of the
{surface}_updates
parameter to allow customization of a surface starting at a base surface (e.g.geom_hockey("NHL", surface_updates = list(rink_length = 400)))
will create a regulation NHL ice rink that is twice as long as it should be. This allows the package to better handle edge cases and support more users off the bat with less internal maintenanceIntroduction of the
color_updates
parameter to allow colors of features to change more easily and explicitly internally in the codeIntroduction of
x_trans
andy_trans
argument for every surface to adjust positioning of origin
Breaking Changes (and justifications for breaks)
Removed
full_surf
androtation_dir
arguments to allow fordisplay_range
and more flexiblerotation
arguments to be introduced. The improved argument structure will allow for more granular “zoom” on plots to regions of interest, as well as adjusting coordinates appropriately to match data setsRemoved
vdiffr
tests as these were becoming unmanageable and didn’t scale well to new leagues. Additionally, should a league change its dimension requirements, the case itself is no longer valid despite the league’s plot requiring the change. Instead, the individual plotting functions are checked as well as the classes of the resulting plots
sportyR 1.0.4
Removed requirement to include a plot caption color (fixes #3)
On September 7, 2021, the NWHL changed names to be the PHF. This name change is now reflected in the package, with NWHL still valid so as to be backwards compatible.
sportyR 1.0.3
- Added tennis plotting capability
- Fixed issue with NCAA football plot hash marks (initially typed as 6, should have been typed as 60)
- Fixed minor bug with all soccer plots (changed
rotation_dir = TRUE
torotation_dir = "ccw"
) - Fixed minor bug in NCAA hockey plots when plotting in units other than
ft
(reorderedgeom_ncaa_hockey()
code to adjust units before plotting) - Restructured code in
tests/testthat/test-plot-functions.R
to more closely resemble rest of repository structure. Plots now tested by sport rather than by plot-specific feature (e.g. units or rotation) - Fixed minor bug with converting between millimeters and feet (originally was specified as 3048mm per foot, corrected to 304.8mm per foot)
sportyR 1.0.0
CRAN release: 2021-04-19
Initial release! Ability to plot baseball, basketball ((W)NBA, NCAA, and FIBA), football (NFL and NCAA), hockey ((W)NHL, IIHF, NCAA), and soccer (FIFA, MLS, NCAA, NWSL, and Premier League) is included, with the capability to customize outputs in specific colors.