Add valid year ranges to the docs#127
Open
bradisbrad wants to merge 10 commits into
Open
Conversation
Annoyingly changes link structure, presumably due to roxygen update
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @bradisbrad, your pull request is larger than the review limit of 150000 diff characters
Contributor
|
Important Review skippedToo many files! This PR contains 169 files, which is 69 over the limit of 100. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (169)
You can disable this status message by setting the ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Author
|
I think these failures are fixed in #126 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Table of Contents generated with DocToc
Pull Request
Summary
Creates an auto-updater script and an internal dataframe to dynamically surface minimum years for functions that have a year argument.
Type of Change
feat: New feature (e.g. newcfbd_*,espn_cfb_*, orload_cfb_*wrapper)fix: Bug fixdocs: Documentation only (roxygen, README, NEWS, vignettes)test: Adding or updating tests (includes the pbp equivalence harness)refactor: Code refactoring (no functional change -- e.g. extracting helpers intoR/pbp_*.R)chore: Maintenance / tooling (.Rbuildignore,tools/, lockfiles)perf: Performance improvementci: GitHub Actions / workflow changesRelated Issues
Closes #37
Background & Context
Main thing here is that the script looks for all functions that have a
yearargument, and sets defaults for week (if required) and ESPN team_id (where necessary) when running the auto-updater. I also make a couple of assumptions on inheritance for ease of use so we don't need to search across time for athlete IDs from previous years to dynamically set defaults for the updater, so these might not be perfect minimums, but certainly a good estimate.In some cases, we have functions that return results with a year all the way back to 1000. This is partially addressed in #126, but largely what's happening here is ESPN is returning current state but requiring a year to be passed, so I'm allowing those to pass through until we figure out what we want to do about those calls.
Changes Made
sysdata.rdacalledmin_year_map_df, which stores minimum year for a function, a last updated date, and the function that supplies the minimum year, if inheritedraw-data/that works through all functions in the table and updates minimum yearraw-data/from .gitignore (still in .RBuildIgnore)Submission Checklist
snake_case, 2-space indent, native pipe|>)tryCatchblock (e.g.df_list <- list(),plays_df <- NULL)dplyr::select(-dplyr::any_of(...)); renames usedplyr::rename(dplyr::any_of(c(new = "old")))cli::cli_alert_*()/cli::cli_warn()/cli::cli_abort()(notmessage()/stop()/warning())devtools::document()has been run (NAMESPACE updated; no hand-edits toman/orNAMESPACE)@export,@family,@return, and a runnable example (\donttest{}for live-network calls)tests/testthat/withskip_on_cran()+skip_on_ci()and a skip-if-empty guard right after the API callexpect_in(sort(expected), sort(colnames(x)))test-pbp_equivalence.Rstill passes (or the allow-list is updated with justification)devtools::check()passes with no errors or warningsNEWS.mdupdated under the current# **cfbfastR 2.3.0**heading (if user-facing)cran-comments.mdupdated (if behavioural / user-visible)_pkgdown.ymlupdated for new exports that need an explicit reference entry (thestarts_with("cfbd_")/starts_with("espn_cfb_")selectors pick up most prefix-matching additions automatically)README.Rmdre-rendered withdevtools::build_readme()if README content changedDESCRIPTIONnormalized withusethis::use_tidy_description()if it was editedNEWS.md/CLAUDE.md/CONTRIBUTING.md/.github/copilot-instructions.md/.github/pull_request_template.mdchangedtype: description); no AI co-authorsReviewer Checklist
Reviewers: Do not approve until all items are verified
NEWS.md,cran-comments.md,_pkgdown.yml, roxygen) has been updated or marked N/A with justificationAdditional Notes