diff --git a/.Rbuildignore b/.Rbuildignore index 934ae53..d303b81 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,4 @@ ^docs$ ^pkgdown$ ^\.github$ +^vignettes/articles$ diff --git a/DESCRIPTION b/DESCRIPTION index b280278..9d22625 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -35,3 +35,4 @@ Imports: Roxygen: list(markdown = TRUE) URL: https://cbbdata.aweatherman.com/ BugReports: https://github.com/andreweatherman/cbbdata +Config/Needs/website: rmarkdown diff --git a/README.Rmd b/README.Rmd index 0b5cb4b..6f806cd 100644 --- a/README.Rmd +++ b/README.Rmd @@ -19,7 +19,7 @@ library(tidyverse) -In the vast arena of college basketball data, finding comprehensive, easily accessible, and up-to-date statistics can be a daunting task. cbbdata emerges as your reliable partner in this quest, offering an unparalleled depth of college basketball insights, just a line of code away. +In the vast arena of college basketball data, finding comprehensive, easily accessible, and up-to-date statistics can be a daunting task. `cbbdata` emerges as your reliable partner in this quest, offering an unparalleled depth of college basketball insights, just a line of code away. **Unmatched Access, Uncomplicated Process:** `cbbdata` is your key to unlocking a treasure trove of college basketball statistics. Say goodbye to the hurdles of data scraping. Our package is designed for efficiency and simplicity, providing a straightforward pathway to the data you need. diff --git a/README.md b/README.md index 86da93c..6f4bbc7 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ In the vast arena of college basketball data, finding comprehensive, easily accessible, and up-to-date statistics can be a daunting task. -cbbdata emerges as your reliable partner in this quest, offering an +`cbbdata` emerges as your reliable partner in this quest, offering an unparalleled depth of college basketball insights, just a line of code away. @@ -122,7 +122,7 @@ cbbdata::cbd_torvik_team_factors(year = 2024, no_bias = TRUE) %>% #> team barthag adj_o adj_d #> #> 1 Houston 0.983 116. 81.2 -#> 2 Purdue 0.972 124. 91.1 +#> 2 Purdue 0.972 124. 91.0 #> 3 Arizona 0.971 119. 87.7 #> 4 Connecticut 0.963 125. 93.9 #> 5 BYU 0.956 118. 90.1 diff --git a/_pkgdown.yml b/_pkgdown.yml index 050d7db..3645b4c 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -16,6 +16,7 @@ navbar: structure: left: - reference + - articles - news right: - search diff --git a/man/figures/README-unnamed-chunk-6-1.png b/man/figures/README-unnamed-chunk-6-1.png index 61d916d..4af8d20 100644 Binary files a/man/figures/README-unnamed-chunk-6-1.png and b/man/figures/README-unnamed-chunk-6-1.png differ diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 0000000..097b241 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1,2 @@ +*.html +*.R diff --git a/vignettes/articles/release.Rmd b/vignettes/articles/release.Rmd new file mode 100644 index 0000000..5e5809f --- /dev/null +++ b/vignettes/articles/release.Rmd @@ -0,0 +1,73 @@ +--- +title: "Introducing The CBBData API" +--- + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>" +) +``` + +```{r setup, echo=FALSE, eval=FALSE} +library(cbbdata) +``` + +## Hi, I'm Andrew! + +Hello there! I’m Andrew Weatherman, an avid open-source R developer and a die-hard college basketball enthusiast. My journey with R began during COVID, and I am entirely self-taught. In 2022, I ventured into the realm of "real coding" and developed the `toRvik` package, a tool for accessing college basketball data. It was my first major project and, despite its success, presented a fair share of challenges in maintenance. + +In May 2023, I embarked on a new project: `cbbdata`. This Flask-based API is designed to deliver comprehensive, up-to-date college basketball statistics faster and more efficiently than its predecessor, `toRvik`. `cbbdata` has been a significant undertaking, and I'm excited to finally share it with the community. + +A bit more about me for those joining from Twitter: I graduated from Duke University in 2023. During my time there, I was a student manager for the men's basketball program, coinciding with Coach K's final run and Jon Scheyer's first season. + +Currently, I'm pursuing a degree in Mathematics at the University of North Carolina at Charlotte, with an expected graduation date of May 2024. Post-graduation, my plans are to either continue my education with a master’s in data science or jump straight into the workforce. + +## What is cbbdata? + +`cbbdata` is an R package designed for anyone passionate about college basketball statistics. It simplifies the process of accessing and analyzing a wealth of college basketball data, making it more efficient and user-friendly than ever before. + +## Key Features of cbbdata + +`cbbdata` ships with 26 functions, and there is a lot to love about this package. Here are some brief highlights: + +- **Comprehensive Game-by-Game Logs:** Access detailed box scores and advanced metrics for players and teams dating back to 2008 (`cbd_torvik_player_game` and `cbd_torvik_game_box/factors`). You can further find per-game player and team splits on month, location, result, and game type factors (`cbd_torvik_player/team_split`). + +- **Daily Updated NET Rankings:** Find the latest NET rankings every morning (`cbd_torvik_current_resume`). + +- **Game Predictions with Barttorvik:** Simulate any matchup, real or otherwise, using our game prediction feature, powered by Barttorvik (`cbd_torvik_game_prediction`). It’s perfect for pre-game analyses and hypothetical scenario discussions. + +- **Plot team logos with `gt`:** Okay, sure, this one isn't data-focused, but it's perhaps my favorite function. Rebuild your `team` column with a logo and team name and render in a `gt` table. Gone are the days of awkwardly having separate columns for your logo and team name (`cbd_gt_logos`). [Just like here!](https://x.com/andreweatherman/status/1730678741846704451?s=20) + +## Why cbbdata? + +`cbbdata` is designed with the end-user in mind. It's built from the ground up to be more powerful, yet as intuitive as `toRvik`. The package aims to address some of the limitations of `toRvik` while introducing new features and capabilities. Importantly, say goodbye to loops! With `cbbdata`, you can access full data files by passing no arguments to functions. Otherwise, you can filter by year, team, conference, etc. + +## A Note on Documentation + +I am aware that the documentation is still a work in progress. As a developer passionate about this project, I wanted to release `cbbdata` to the community as soon as possible. Continuous improvements and updates to the documentation will be made. + +This release marks just the beginning. I am committed to regular updates and improvements to `cbbdata`, based on community feedback and evolving needs. + +## Get Started with cbbdata + +`cbbdata` is now available for use! Start by signing up for a free API key, and you’ll be on your way to exploring the depths of college basketball statistics. + +### Install + +```{r, eval = FALSE} +# install.packages("devtools") +devtools::install_github("andreweatherman/cbbdata") +``` + +### Registering + +```{r, eval=FALSE} +cbbdata::cbd_create_account(username, email, password, confirm_password) +``` + + +## Your Feedback Matters + +As with `toRvik`, your feedback is invaluable in shaping `cbbdata`. I encourage you to share your experiences, suggestions, and questions. You can find me on [Twitter](https://twitter.com/andreweatherman). +