Refresh README for portfolio readme-refresh gate - #78
bbuchsbaum merged 2 commits into
Conversation
Align the first screen with Promise → Proof → Scope → Route: keep four current badges (CRAN, R-CMD-check, pkgdown, Codecov), add live docs routes, document CRAN vs GitHub versions, and replace the vignette-only example with a verified bids_project()/func_scans() quick start. Co-authored-by: bbuchsbaum <bbuchsbaum@users.noreply.github.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dd4a1172f7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| library(bidser) | ||
|
|
||
| Install the development version from [GitHub](https://github.com/) with: | ||
| ds_path <- get_example_bids_dataset("ds001") |
There was a problem hiding this comment.
On a fresh installation following the preceding install.packages("bidser") command, this call can fail before the quick start begins: get_example_bids_dataset() explicitly requires httr and internet access (R/bids.R:1933-1960), while httr is only a Suggests dependency (DESCRIPTION:31-34) and therefore is not installed automatically. Document these prerequisites and installation step, or base the quick start on an offline fixture such as create_mock_bids().
Useful? React with 👍 / 👎.
Avoid get_example_bids_dataset() in the documented install path: it needs
Suggests-only httr and network access. Use the exported create_mock_bids()
fixture so the quick start runs after install.packages("bidser").
Co-authored-by: bbuchsbaum <bbuchsbaum@users.noreply.github.com>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
2 participants
Leaves #77 open until the portfolio monitor verifies the merged default-branch SHA and hosted evidence.
Summary
create_mock_bids()plusparticipants()/tasks()/func_scans()so it runs afterinstall.packages("bidser")without Suggests-onlyhttror network access (addresses Codex P2).confound_set()/confound_strategy()helpers; linked the downloaded-dataset tour to the quickstart vignette.Verification
README.Rmd→README.mdsuccessfully.test_confounds.R,test_func_scans.R, andtest_events.R: 0 fails.Notes
master.