_pkgdown.yml

url: https://sportyR.sportsdataverse.org
title: sportyR
description: "Create scaled ggplot representations of playing surfaces. Playing surfaces are drawn pursuant to rule-book specifications. This package should be used as a baseline plot for displaying player tracking data."

template:
  bootstrap: 5
  bootswatch: cosmo
  bslib:
    primary: "#1fb22e" # Navbar color
    secondary: "#1fb22e" # Secondary navbar color
    btn-btn-secondary-bg: "#1fb22e"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem
  opengraph:
    image:
      src: "https://raw.githubusercontent.com/sportsdataverse/sportyR/main/logos/sportyr-logo-hex.png"
      alt: "sportyR social preview hex"
    twitter:
      creator: "@rossdrucker"
      site: "@sportsdataverse"
      card: summary


authors:
  Ross Drucker:
    href: https://twitter.com/rossdrucker9
navbar:
  structure:
    left: [home, reference, articles, news, network, ]
    right: [twitter, github]
  components:
    home:
      title: sportyR • Drawing regulation playing surfaces
      description: >
        A set of functions for drawing regulation playing surfaces
        with 'ggplot2'.
      icon: fa-home
      href: index.html
    reference:
      icon: "fas fa-code"
      text: "Funcs"
      href: reference/index.html
    articles:
      icon: "fas fa-book-reader"
      text: " Articles"
      href: articles/index.html
      menu:
      - text: Vignettes
        href: articles/index.html
      - text: Getting Started
        href: articles/sportyR.html
      - text: Customizing Plots
        href: articles/customize-plot.html
      - text: Plotting Tracking Data
        href: articles/plotting-tracking-data.html
      - text: Animating Tracking Data
        href: articles/animating-tracking-data.html
    news:
      icon: "fas fa-newspaper"
      text: " Changelog"
      href: news/index.html
    network:
      icon: "fas fa-project-diagram"
      text: " SDV"
      menu:
      - text: SportsDataverse
        href: https://sportsdataverse.org/
      - text: --------------------------------
      - text: R Packages
      - text: sportsdataverse-R
        href: https://r.sportsdataverse.org/
      - text: cfbfastR
        href: https://cfbfastR.sportsdataverse.org/
      - text: hoopR
        href: https://hoopR.sportsdataverse.org/
      - text: wehoop
        href: https://wehoop.sportsdataverse.org/
      - text: toRvik
        href: https://torvik.dev/
      - text: fastRhockey
        href: https://fastRhockey.sportsdataverse.org/
      - text: baseballr
        href: https://BillPetti.github.io/baseballr/
      - text: worldfootballR
        href: https://jaseziv.github.io/worldfootballR/
      - text: chessR
        href: https://jaseziv.github.io/chessR/
      - text: sportyR
        href: https://rossdrucker.github.io/sportyR/
      - text: cfbplotR
        href: https://kazink36.github.io/cfbplotR/
      - text: cfb4th
        href: https://kazink36.github.io/cfb4th/
      - text: recruitR
        href: https://recruitr.sportsdataverse.org/
      - text: gamezoneR
        href: https://jacklich10.github.io/gamezoneR/
      - text: puntr
        href: https://puntalytics.github.io/puntr/
      - text: --------------------------------
      - text: Python Packages
      - text: sportsdataverse-py
        href: https://py.sportsdataverse.org/
      - text: --------------------------------
      - text: Node.js Packages
      - text: sportsdataverse.js
        href: https://js.sportsdataverse.org/
      - text: nfl-nerd
        href: https://github.com/nntrn/nfl-nerd/
    twitter:
      icon: "fab fa-twitter fa-lg"
      href: http://twitter.com/rossdrucker9
    github:
      icon: "fab fa-github fa-lg"
      href: https://github.com/sportsdataverse/sportyR
reference:
- title: "Surface Plotters"
  desc: Functions that do the actual plotting of the surfaces
  contents:
    - "`geom_baseball`"
    - "`geom_basketball`"
    - "`geom_curling`"
    - "`geom_football`"
    - "`geom_hockey`"
    - "`geom_lacrosse`"
    - "`geom_soccer`"
    - "`geom_tennis`"
    - "`geom_volleyball`"
- title: "cani_ Functions"
  desc: >
    Functions that help navigate the options of the package,
    attempting to answer questions starting "Can I..."
  contents:
    - "`cani_color_league_features`"
    - "`cani_plot_league`"
    - "`cani_plot_sport`"
- title: internal
  desc: Internal functions to `sportyR` you might find useful
  contents:
    - "`surface_dimensions`"
    - "`convert_units`"
    - "`distance_formula`"
    - "`quadratic_formula`"
    - "`reflect`"
    - "`rotate_coords`"
    - "`%or%`"