Skip to content

docs(readme): link the sdvplot and sdvtables JavaScript packages #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saiemgilani merged 2 commits into from
Oct 9, 2026
Merged

docs(readme): link the sdvplot and sdvtables JavaScript packages #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12a7028
docs(readme): link the sdvplot and sdvtables JavaScript packages
saiemgilani Oct 9, 2026
1fa5733
docs(readme): install sporty with sdvplot; add a NEWS bullet
saiemgilani Oct 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ college football, men's and women's college basketball, and soccer), built on 'g
and following the conventions of 'nflplotR', 'cfbplotR', 'nbaplotR' and
'mlbplotR'.

* The README links the JavaScript / TypeScript siblings on npm,
`@sportsdataverse/sdvplot` and `@sportsdataverse/sdvtables`
(<https://plot.sportsdataverse.org>).
* Saving a table to an image (`gt_save_crop()`, `gt_social_crop()`,
`gt_save_batch()`, `gt_grid()`, `gt_stack_tables()`) gives headless Chrome
60 seconds to start instead of chromote's 10: a loaded machine, such as a
Expand Down
10 changes: 10 additions & 0 deletions README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ knitr::opts_chunk$set(
[![Codecov](https://img.shields.io/codecov/c/github/sportsdataverse/sdvplotR?logo=codecov&style=for-the-badge)](https://app.codecov.io/gh/sportsdataverse/sdvplotR)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg?style=for-the-badge&logo=github)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-universe](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=r-universe&prefix=v&query=%24.Version&url=https%3A%2F%2Fsportsdataverse.r-universe.dev%2Fapi%2Fpackages%2FsdvplotR)](https://sportsdataverse.r-universe.dev/sdvplotR)
[![npm sdvplot](https://img.shields.io/npm/v/@sportsdataverse/sdvplot?label=npm%20sdvplot&logo=npm&style=for-the-badge&color=success)](https://www.npmjs.com/package/@sportsdataverse/sdvplot)
[![Contributors](https://img.shields.io/github/contributors/sportsdataverse/sdvplotR?style=for-the-badge)](https://github.com/sportsdataverse/sdvplotR/graphs/contributors)
[![X Follow](https://img.shields.io/twitter/follow/SportsDataverse?color=blue&label=%40SportsDataverse&logo=x&style=for-the-badge)](https://x.com/SportsDataverse)
<!-- badges: end -->
Expand Down Expand Up @@ -62,6 +63,14 @@ pak::pak("sportsdataverse/sdvplotR")
install.packages("sdvplotR", repos = c("https://sportsdataverse.r-universe.dev", "https://cloud.r-project.org"))
```

### **JavaScript / TypeScript**
Comment thread
saiemgilani marked this conversation as resolved.

The same team colors, logos, wordmarks and headshots are on npm as [**`@sportsdataverse/sdvplot`**](https://www.npmjs.com/package/@sportsdataverse/sdvplot), with Observable Plot, D3, React and chart-library integrations plus shot charts. [**`@sportsdataverse/sdvtables`**](https://www.npmjs.com/package/@sportsdataverse/sdvtables) is the counterpart to the `gt` table helpers. Docs: [plot.sportsdataverse.org](https://plot.sportsdataverse.org). Source: [sportsdataverse/sdvplot-js](https://github.com/sportsdataverse/sdvplot-js).

``` sh
npm install @sportsdataverse/sdvplot @sportsdataverse/sdvtables @sportsdataverse/sporty
```

## **Usage**

Every function takes a `sport` argument (`"nfl"`, `"nba"`, `"wnba"`, `"mlb"`, `"nhl"`, `"cfb"`, `"mbb"`, `"wbb"`). Team keys are cleaned automatically: full names, alternate abbreviations used by other data providers and historical abbreviations of relocated franchises (`"OAK"` → `"LV"`, `"SEA"` → `"OKC"`) all resolve to the same team.
Expand Down Expand Up @@ -169,6 +178,7 @@ A printable `sdvplotR` cheat sheet will join [the set covering every SportsDatav
| [**cfbseedR**](https://cfbseedR.sportsdataverse.org/) | CFB seeding and playoff simulation |
| [**sportyR**](https://sportyR.sportsdataverse.org/) | Playing-surface plots |
| [**sportsdataverse-R**](https://r.sportsdataverse.org/) | Umbrella R metapackage |
| [**@sportsdataverse/sdvplot**](https://plot.sportsdataverse.org) · [**@sportsdataverse/sdvtables**](https://plot.sportsdataverse.org/guides/tables) | JavaScript / TypeScript plots and tables |
| [**sportsdataverse-py**](https://py.sportsdataverse.org/) · [**sportsdataverse.js**](https://js.sportsdataverse.org/) | Python and Node.js |

See the full ecosystem at [sportsdataverse.org](https://sportsdataverse.org/).
Expand Down
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg?style=for-the-badge&logo=github)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-universe](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=r-universe&prefix=v&query=%24.Version&url=https%3A%2F%2Fsportsdataverse.r-universe.dev%2Fapi%2Fpackages%2FsdvplotR)](https://sportsdataverse.r-universe.dev/sdvplotR)
[![npm
sdvplot](https://img.shields.io/npm/v/@sportsdataverse/sdvplot?label=npm%20sdvplot&logo=npm&style=for-the-badge&color=success)](https://www.npmjs.com/package/@sportsdataverse/sdvplot)
Comment thread
saiemgilani marked this conversation as resolved.
[![Contributors](https://img.shields.io/github/contributors/sportsdataverse/sdvplotR?style=for-the-badge)](https://github.com/sportsdataverse/sdvplotR/graphs/contributors)
[![X
Follow](https://img.shields.io/twitter/follow/SportsDataverse?color=blue&label=%40SportsDataverse&logo=x&style=for-the-badge)](https://x.com/SportsDataverse)
Expand Down Expand Up @@ -68,6 +70,21 @@ pak::pak("sportsdataverse/sdvplotR")
install.packages("sdvplotR", repos = c("https://sportsdataverse.r-universe.dev", "https://cloud.r-project.org"))
```

### **JavaScript / TypeScript**
Comment thread
coderabbitai[bot] marked this conversation as resolved.

The same team colors, logos, wordmarks and headshots are on npm as
[**`@sportsdataverse/sdvplot`**](https://www.npmjs.com/package/@sportsdataverse/sdvplot),
with Observable Plot, D3, React and chart-library integrations plus shot
charts.
[**`@sportsdataverse/sdvtables`**](https://www.npmjs.com/package/@sportsdataverse/sdvtables)
is the counterpart to the `gt` table helpers. Docs:
[plot.sportsdataverse.org](https://plot.sportsdataverse.org). Source:
[sportsdataverse/sdvplot-js](https://github.com/sportsdataverse/sdvplot-js).

``` sh
npm install @sportsdataverse/sdvplot @sportsdataverse/sdvtables @sportsdataverse/sporty
```

## **Usage**

Every function takes a `sport` argument (`"nfl"`, `"nba"`, `"wnba"`,
Expand Down Expand Up @@ -194,6 +211,7 @@ SportsDataverse package](https://sportsdataverse.org/cheatsheets).
| [**cfbseedR**](https://cfbseedR.sportsdataverse.org/) | CFB seeding and playoff simulation |
| [**sportyR**](https://sportyR.sportsdataverse.org/) | Playing-surface plots |
| [**sportsdataverse-R**](https://r.sportsdataverse.org/) | Umbrella R metapackage |
| [**@sportsdataverse/sdvplot**](https://plot.sportsdataverse.org) · [**@sportsdataverse/sdvtables**](https://plot.sportsdataverse.org/guides/tables) | JavaScript / TypeScript plots and tables |
| [**sportsdataverse-py**](https://py.sportsdataverse.org/) · [**sportsdataverse.js**](https://js.sportsdataverse.org/) | Python and Node.js |

See the full ecosystem at
Expand Down
Loading