Skip to content

Commit e4b03ee

Browse files
authored
docs(articles): bring the pkgdown articles onto the family template (#423)
* docs(articles): bring the pkgdown articles onto the family template Every article is a landing page from search or a shared link, and almost none said who wrote the package or how to cite it: across the 11 SDV R packages, 43 of 47 articles had no author/contributor footer and 44 had no citation block. Adds only what each article was missing -- conformant headers and footers are untouched, so this is a backfill rather than a rewrite: * author line with X/GitHub follow badges, built from DESCRIPTION rather than hand-listed, so authors and contributors stay in sync with the package; * description, lifted from the article's own opening prose. Articles with no prose to lift (parameter tables, pure code walk-throughs) deliberately get none -- filler reads worse than absent, because pkgdown prints it under the title on the article index and search engines lift it; * opengraph image + twitter summary_large_image card pointing at the package's own social card; * the closing Our Authors / Contributors / Citation / Related block. The twitter creator is per package, not uniformly @saiemgilani: cfbfastR has its own handle, sportyR is @sportyR_pkg, and articles written by a specific contributor keep that contributor's handle. * docs(articles): hand-write the descriptions, track hoopR's parameter vignette The auto-extracted opening sentence was serviceable but off-register. The descriptions already in this family are one-liners with `<code>` markup naming the functions the article actually uses, and pkgdown prints them under the title on the article index. These were written after reading each article, so they say what the piece does rather than however it happened to open. hoopR's `vignettes/parameter-descriptions.Rmd` was listed in `vignettes/.gitignore`, so it was never tracked -- edits to it looked applied and silently never reached a commit. wehoop tracks its equivalent, so hoopR was the odd one out. Removed from the ignore list and committed. * docs(articles): fix the GitHub handles and BibTeX from the bot review The GitHub follow badges reused each person's X handle. Those are different namespaces, and 20 of 28 badge URLs returned 404 -- Tan Ho is @_TanHo on X but tanho63 on GitHub, Ross Drucker is @rossdrucker9 and rossdrucker, Eric Hess is @arbitanalytics and ehess. Both handles are now harvested from the packages' own READMEs, which list them side by side, and the GitHub badge is omitted where no handle is evidenced rather than guessed. Guessing was tried and rejected: `github.com/RobertFrey` and `github.com/BillyFryer` both resolve, but the handles baseballr and hoopR actually link are `robert-frey` and `billyfryer`. A 200 proves a profile exists, not that it belongs to the right person. Every handle now in the articles was checked to resolve. Also from the review: * BibTeX author lists joined names with commas. BibTeX wants ` and `; with commas a parser reads two people as one "Surname, Given". * Where the package ships `inst/CITATION`, its title and year are used instead of a generated title and a hard-coded 2026. * "BibTex" -> "BibTeX". * Contributors now get the same X + GitHub badge pair as authors. * sportyR's vignette rendered both a hand-written `Author` section and the generated `Our Authors` one; the superseded section is removed. * cfbplotR: `man/cfbplotR-package.Rd` still named the previous maintainer. roxygenise() cannot run in this checkout (pre-existing `logo_ref` load failure), so the one derived line is synced to DESCRIPTION by hand. * cfbplotR tutorial: "we can being to use" -> "we can begin to use".
1 parent f798bff commit e4b03ee

4 files changed

Lines changed: 171 additions & 4 deletions

File tree

vignettes/baseballr.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Getting Started with baseballr"
33
description: "Getting started with using <code>baseballr</code> and men's baseball data."
4-
author: "Saiem Gilani <br> <a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>"
4+
author: "Bill Petti, Saiem Gilani <br><a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a> <a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>"
55
date: "`r Sys.Date()`"
66
opengraph:
77
image:

vignettes/ncaa_scraping.Rmd

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
22
title: "NCAA Scraping"
3-
author: "Bill Petti"
3+
author: "Bill Petti, Saiem Gilani <br><a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a> <a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>"
44
date: "2016-11-22"
55
output: html_document
6+
description: "Pulling college baseball player and team statistics from the NCAA's website with <code>ncaa_scrape()</code>, including batting, pitching and fielding splits by season."
7+
opengraph:
8+
image:
9+
src: "https://raw.githubusercontent.com/sportsdataverse/baseballr-data/main/themes/baseballr_gh.png"
10+
twitter:
11+
card: summary_large_image
12+
creator: "@saiemgilani"
613
---
714

815
```{r setup, include = FALSE}
@@ -65,3 +72,51 @@ Just pass a string to the function and it will return possible matches based on
6572
ncaa_school_id_lu("Vand")
6673
```
6774

75+
# **Our Authors**
76+
- [Bill Petti](https://x.com/BillPetti)
77+
<a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a>
78+
<a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a>
79+
- [Saiem Gilani](https://x.com/saiemgilani)
80+
<a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a>
81+
<a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>
82+
83+
## **Our Contributors**
84+
- [Ben Baumer](https://x.com/BaumerBen)
85+
<a href='https://x.com/BaumerBen' target='blank'><img src='https://img.shields.io/twitter/follow/BaumerBen?color=blue&amp;label=%40BaumerBen&amp;logo=x&amp;style=for-the-badge' alt='@BaumerBen'/></a>
86+
<a href='https://github.com/beanumber' target='blank'><img src='https://img.shields.io/github/followers/beanumber?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@beanumber'/></a>
87+
- [Ben Dilday](https://x.com/BenDilday)
88+
<a href='https://x.com/BenDilday' target='blank'><img src='https://img.shields.io/twitter/follow/BenDilday?color=blue&amp;label=%40BenDilday&amp;logo=x&amp;style=for-the-badge' alt='@BenDilday'/></a>
89+
<a href='https://github.com/bdilday' target='blank'><img src='https://img.shields.io/github/followers/bdilday?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@bdilday'/></a>
90+
- [Robert Frey](https://x.com/RobertFrey40)
91+
<a href='https://x.com/RobertFrey40' target='blank'><img src='https://img.shields.io/twitter/follow/RobertFrey40?color=blue&amp;label=%40RobertFrey40&amp;logo=x&amp;style=for-the-badge' alt='@RobertFrey40'/></a>
92+
<a href='https://github.com/robert-frey' target='blank'><img src='https://img.shields.io/github/followers/robert-frey?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@robert-frey'/></a>
93+
- [Camden Kay](https://x.com/k_camden)
94+
<a href='https://x.com/k_camden' target='blank'><img src='https://img.shields.io/twitter/follow/k_camden?color=blue&amp;label=%40k_camden&amp;logo=x&amp;style=for-the-badge' alt='@k_camden'/></a>
95+
<a href='https://github.com/camdenk' target='blank'><img src='https://img.shields.io/github/followers/camdenk?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@camdenk'/></a>
96+
97+
## **Citation**
98+
99+
To cite the [**`baseballr`**](https://baseballr.sportsdataverse.org/) R package in publications, use:
100+
101+
BibTeX Citation
102+
103+
```bibtex
104+
@misc{baseballr,
105+
author = {Bill Petti and Saiem Gilani},
106+
title = {baseballr: An R Package for Baseball Data Acquisition and Analysis},
107+
url = {https://baseballr.sportsdataverse.org/},
108+
year = {2026}
109+
}
110+
```
111+
112+
## **Related SportsDataverse packages**
113+
114+
- [**cfbfastR**](https://cfbfastR.sportsdataverse.org/) - college football
115+
- [**hoopR**](https://hoopR.sportsdataverse.org/) - men's basketball
116+
- [**wehoop**](https://wehoop.sportsdataverse.org/) - women's basketball
117+
- [**baseballr**](https://baseballr.sportsdataverse.org/) - baseball
118+
- [**fastRhockey**](https://fastRhockey.sportsdataverse.org/) - hockey
119+
- [**oddsapiR**](https://oddsapiR.sportsdataverse.org/) - betting odds
120+
- [**sportyR**](https://sportyR.sportsdataverse.org/) - playing surfaces
121+
- [**sportsdataverse-py**](https://py.sportsdataverse.org/) - the Python package
122+
- [**sportsdataverse-R**](https://r.sportsdataverse.org/) - the R meta-package

vignettes/plotting_statcast.Rmd

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
22
title: "Plotting Statcast data"
3-
author: "Bill Petti"
3+
author: "Bill Petti, Saiem Gilani <br><a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a> <a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>"
44
date: "`r Sys.Date()`"
55
output: html_document
6+
description: "Drawing strike-zone plots and pitch locations from Statcast data with <code>ggplot2</code>, including how to place the zone correctly for left- and right-handed batters."
7+
opengraph:
8+
image:
9+
src: "https://raw.githubusercontent.com/sportsdataverse/baseballr-data/main/themes/baseballr_gh.png"
10+
twitter:
11+
card: summary_large_image
12+
creator: "@saiemgilani"
613
---
714

815
```{r setup, include = FALSE}
@@ -117,3 +124,52 @@ with the batter's strike zone overlaid, using the Savant palette by default:
117124
```{r, eval=FALSE}
118125
ggpitchzone(betts_16)
119126
```
127+
128+
# **Our Authors**
129+
- [Bill Petti](https://x.com/BillPetti)
130+
<a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a>
131+
<a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a>
132+
- [Saiem Gilani](https://x.com/saiemgilani)
133+
<a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a>
134+
<a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>
135+
136+
## **Our Contributors**
137+
- [Ben Baumer](https://x.com/BaumerBen)
138+
<a href='https://x.com/BaumerBen' target='blank'><img src='https://img.shields.io/twitter/follow/BaumerBen?color=blue&amp;label=%40BaumerBen&amp;logo=x&amp;style=for-the-badge' alt='@BaumerBen'/></a>
139+
<a href='https://github.com/beanumber' target='blank'><img src='https://img.shields.io/github/followers/beanumber?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@beanumber'/></a>
140+
- [Ben Dilday](https://x.com/BenDilday)
141+
<a href='https://x.com/BenDilday' target='blank'><img src='https://img.shields.io/twitter/follow/BenDilday?color=blue&amp;label=%40BenDilday&amp;logo=x&amp;style=for-the-badge' alt='@BenDilday'/></a>
142+
<a href='https://github.com/bdilday' target='blank'><img src='https://img.shields.io/github/followers/bdilday?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@bdilday'/></a>
143+
- [Robert Frey](https://x.com/RobertFrey40)
144+
<a href='https://x.com/RobertFrey40' target='blank'><img src='https://img.shields.io/twitter/follow/RobertFrey40?color=blue&amp;label=%40RobertFrey40&amp;logo=x&amp;style=for-the-badge' alt='@RobertFrey40'/></a>
145+
<a href='https://github.com/robert-frey' target='blank'><img src='https://img.shields.io/github/followers/robert-frey?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@robert-frey'/></a>
146+
- [Camden Kay](https://x.com/k_camden)
147+
<a href='https://x.com/k_camden' target='blank'><img src='https://img.shields.io/twitter/follow/k_camden?color=blue&amp;label=%40k_camden&amp;logo=x&amp;style=for-the-badge' alt='@k_camden'/></a>
148+
<a href='https://github.com/camdenk' target='blank'><img src='https://img.shields.io/github/followers/camdenk?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@camdenk'/></a>
149+
150+
## **Citation**
151+
152+
To cite the [**`baseballr`**](https://baseballr.sportsdataverse.org/) R package in publications, use:
153+
154+
BibTeX Citation
155+
156+
```bibtex
157+
@misc{baseballr,
158+
author = {Bill Petti and Saiem Gilani},
159+
title = {baseballr: An R Package for Baseball Data Acquisition and Analysis},
160+
url = {https://baseballr.sportsdataverse.org/},
161+
year = {2026}
162+
}
163+
```
164+
165+
## **Related SportsDataverse packages**
166+
167+
- [**cfbfastR**](https://cfbfastR.sportsdataverse.org/) - college football
168+
- [**hoopR**](https://hoopR.sportsdataverse.org/) - men's basketball
169+
- [**wehoop**](https://wehoop.sportsdataverse.org/) - women's basketball
170+
- [**baseballr**](https://baseballr.sportsdataverse.org/) - baseball
171+
- [**fastRhockey**](https://fastRhockey.sportsdataverse.org/) - hockey
172+
- [**oddsapiR**](https://oddsapiR.sportsdataverse.org/) - betting odds
173+
- [**sportyR**](https://sportyR.sportsdataverse.org/) - playing surfaces
174+
- [**sportsdataverse-py**](https://py.sportsdataverse.org/) - the Python package
175+
- [**sportsdataverse-R**](https://r.sportsdataverse.org/) - the R meta-package

vignettes/using_statcast_pitch_data.Rmd

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
22
title: "Using Statcast Pitch Data"
3-
author: "Camden Kay"
3+
author: "Bill Petti, Saiem Gilani <br><a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a> <a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a> <a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>"
44
date: "`r Sys.Date()`"
55
output: html_document
6+
description: "Working with pitch-by-pitch Statcast data from Baseball Savant - acquiring it with <code>statcast_search()</code> and shaping it for pitch-level analysis."
7+
opengraph:
8+
image:
9+
src: "https://raw.githubusercontent.com/sportsdataverse/baseballr-data/main/themes/baseballr_gh.png"
10+
twitter:
11+
card: summary_large_image
12+
creator: "@saiemgilani"
613
---
714

815
```{r setup, include = FALSE}
@@ -175,3 +182,52 @@ milb <- statcast_search_minors(start_date = "2024-06-01", end_date = "2024-06-01
175182
# World Baseball Classic
176183
wbc <- statcast_search_wbc(start_date = "2023-03-21", end_date = "2023-03-21")
177184
```
185+
186+
# **Our Authors**
187+
- [Bill Petti](https://x.com/BillPetti)
188+
<a href='https://x.com/BillPetti' target='blank'><img src='https://img.shields.io/twitter/follow/BillPetti?color=blue&amp;label=%40BillPetti&amp;logo=x&amp;style=for-the-badge' alt='@BillPetti'/></a>
189+
<a href='https://github.com/BillPetti' target='blank'><img src='https://img.shields.io/github/followers/BillPetti?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@BillPetti'/></a>
190+
- [Saiem Gilani](https://x.com/saiemgilani)
191+
<a href='https://x.com/saiemgilani' target='blank'><img src='https://img.shields.io/twitter/follow/saiemgilani?color=blue&amp;label=%40saiemgilani&amp;logo=x&amp;style=for-the-badge' alt='@saiemgilani'/></a>
192+
<a href='https://github.com/saiemgilani' target='blank'><img src='https://img.shields.io/github/followers/saiemgilani?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@saiemgilani'/></a>
193+
194+
## **Our Contributors**
195+
- [Ben Baumer](https://x.com/BaumerBen)
196+
<a href='https://x.com/BaumerBen' target='blank'><img src='https://img.shields.io/twitter/follow/BaumerBen?color=blue&amp;label=%40BaumerBen&amp;logo=x&amp;style=for-the-badge' alt='@BaumerBen'/></a>
197+
<a href='https://github.com/beanumber' target='blank'><img src='https://img.shields.io/github/followers/beanumber?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@beanumber'/></a>
198+
- [Ben Dilday](https://x.com/BenDilday)
199+
<a href='https://x.com/BenDilday' target='blank'><img src='https://img.shields.io/twitter/follow/BenDilday?color=blue&amp;label=%40BenDilday&amp;logo=x&amp;style=for-the-badge' alt='@BenDilday'/></a>
200+
<a href='https://github.com/bdilday' target='blank'><img src='https://img.shields.io/github/followers/bdilday?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@bdilday'/></a>
201+
- [Robert Frey](https://x.com/RobertFrey40)
202+
<a href='https://x.com/RobertFrey40' target='blank'><img src='https://img.shields.io/twitter/follow/RobertFrey40?color=blue&amp;label=%40RobertFrey40&amp;logo=x&amp;style=for-the-badge' alt='@RobertFrey40'/></a>
203+
<a href='https://github.com/robert-frey' target='blank'><img src='https://img.shields.io/github/followers/robert-frey?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@robert-frey'/></a>
204+
- [Camden Kay](https://x.com/k_camden)
205+
<a href='https://x.com/k_camden' target='blank'><img src='https://img.shields.io/twitter/follow/k_camden?color=blue&amp;label=%40k_camden&amp;logo=x&amp;style=for-the-badge' alt='@k_camden'/></a>
206+
<a href='https://github.com/camdenk' target='blank'><img src='https://img.shields.io/github/followers/camdenk?color=eee&amp;logo=Github&amp;style=for-the-badge' alt='@camdenk'/></a>
207+
208+
## **Citation**
209+
210+
To cite the [**`baseballr`**](https://baseballr.sportsdataverse.org/) R package in publications, use:
211+
212+
BibTeX Citation
213+
214+
```bibtex
215+
@misc{baseballr,
216+
author = {Bill Petti and Saiem Gilani},
217+
title = {baseballr: An R Package for Baseball Data Acquisition and Analysis},
218+
url = {https://baseballr.sportsdataverse.org/},
219+
year = {2026}
220+
}
221+
```
222+
223+
## **Related SportsDataverse packages**
224+
225+
- [**cfbfastR**](https://cfbfastR.sportsdataverse.org/) - college football
226+
- [**hoopR**](https://hoopR.sportsdataverse.org/) - men's basketball
227+
- [**wehoop**](https://wehoop.sportsdataverse.org/) - women's basketball
228+
- [**baseballr**](https://baseballr.sportsdataverse.org/) - baseball
229+
- [**fastRhockey**](https://fastRhockey.sportsdataverse.org/) - hockey
230+
- [**oddsapiR**](https://oddsapiR.sportsdataverse.org/) - betting odds
231+
- [**sportyR**](https://sportyR.sportsdataverse.org/) - playing surfaces
232+
- [**sportsdataverse-py**](https://py.sportsdataverse.org/) - the Python package
233+
- [**sportsdataverse-R**](https://r.sportsdataverse.org/) - the R meta-package

0 commit comments

Comments
 (0)