Skip to content

Repair shared formatting, spelling, and badge-link checks #625

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

Open
M-Colley wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Repair shared formatting, spelling, and badge-link checks #625

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
9356696
Repair baseline formatting and spelling checks
M-Colley Oct 27, 2026
cbc1d79
Point the stars badge at the public repository page
M-Colley Oct 27, 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
2 changes: 1 addition & 1 deletion NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Bug fixes

New features

* `report_ai()`: add support for `glm`, `merMod` (lme4), and `glmmTMB` model classes.
* `report_ai()`: add support for `glm`, `merMod` (`lme4`), and `glmmTMB` model classes.

* `report_ai()`: `## Model` section now includes a CI / degrees-of-freedom estimation line (e.g., `Inference: 95% CI [Satterthwaite df]`) when the information is available from `parameters::model_parameters()`.

Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ library(report)
[![r-universe](https://easystats.r-universe.dev/badges/report)](https://easystats.r-universe.dev/report)
[![downloads](http://cranlogs.r-pkg.org/badges/report)](https://cran.r-project.org/package=report)
[![total](https://cranlogs.r-pkg.org/badges/grand-total/report)](https://cranlogs.r-pkg.org/)
[![stars](https://img.shields.io/github/stars/easystats/report?style=social)](https://github.com/easystats/report/stargazers)
[![stars](https://img.shields.io/github/stars/easystats/report?style=social)](https://github.com/easystats/report)

***"From R to your manuscript"***

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![r-universe](https://easystats.r-universe.dev/badges/report)](https://easystats.r-universe.dev/report)
[![downloads](http://cranlogs.r-pkg.org/badges/report)](https://cran.r-project.org/package=report)
[![total](https://cranlogs.r-pkg.org/badges/grand-total/report)](https://cranlogs.r-pkg.org/)
[![stars](https://img.shields.io/github/stars/easystats/report?style=social)](https://github.com/easystats/report/stargazers)
[![stars](https://img.shields.io/github/stars/easystats/report?style=social)](https://github.com/easystats/report)

***“From R to your manuscript”***

Expand Down
4 changes: 4 additions & 0 deletions inst/WORDLIST
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ ENP
Gabry
Hotfix
IC
LLM
LLMs
Magnusson
Mattan
Newcombe
Expand All @@ -32,9 +34,11 @@ glmmTMB
htest
ivreg
participants’
pre
rstanarm
sIgnificance
setosa
suboptimal
tidyverse
unarchive
versicolor
Expand Down
13 changes: 9 additions & 4 deletions man/report.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/testthat/test-report_intercept.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
data2$f <- relevel(data2$f, 3)

# insight::get_data needs access to data in global environment
data1 <<- data1

Check warning on line 26 in tests/testthat/test-report_intercept.R

View workflow job for this annotation

GitHub Actions / lint / lint 

file=tests/testthat/test-report_intercept.R,line=26,col=7,[assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.

Check warning on line 26 in tests/testthat/test-report_intercept.R

View workflow job for this annotation

GitHub Actions / lint-changed-files / lint-changed-files 

file=tests/testthat/test-report_intercept.R,line=26,col=7,[assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.
data2 <<- data2

Check warning on line 27 in tests/testthat/test-report_intercept.R

View workflow job for this annotation

GitHub Actions / lint / lint 

file=tests/testthat/test-report_intercept.R,line=27,col=7,[assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.

Check warning on line 27 in tests/testthat/test-report_intercept.R

View workflow job for this annotation

GitHub Actions / lint-changed-files / lint-changed-files 

file=tests/testthat/test-report_intercept.R,line=27,col=7,[assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.
data3 <<- data3

Check warning on line 28 in tests/testthat/test-report_intercept.R

View workflow job for this annotation

GitHub Actions / lint / lint 

file=tests/testthat/test-report_intercept.R,line=28,col=7,[assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.

Check warning on line 28 in tests/testthat/test-report_intercept.R

View workflow job for this annotation

GitHub Actions / lint-changed-files / lint-changed-files 

file=tests/testthat/test-report_intercept.R,line=28,col=7,[assignment_linter] Replace <<- by assigning to a specific environment (with assign() or <-) to avoid hard-to-predict behavior.

# contrasts, ref. level = category 3
m1 <- lm(y ~ f, data = data1)
Expand All @@ -52,7 +52,7 @@

# Logical predictor
on.exit(data("mtcars"), add = TRUE)

mtcars$more_than_4_cyl <- as.logical(mtcars$cyl > 4)
m4 <- lm(mpg ~ more_than_4_cyl, data = mtcars)
expect_identical(
Expand Down
2 changes: 1 addition & 1 deletion vignettes/report_ai.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The **report** package was originally designed in a pre-AI era with one overarch

However, the analytical landscape has fundamentally changed. Today, researchers increasingly rely on AI agents and Large Language Models (LLMs) to help interpret results, summarize findings, and draft manuscripts, often by simply **pasting raw outputs directly into a chat window**. This shift prompted us to ask: should the scope of the *report* package be expanded to **support** this new workflow, rather than pretending it doesn't exist? And it wasn't even a matter of staying relevant, it was a matter of empowering our users to get the best possible results from their new AI assistants.

While our standard narrative outputs are excellent for humans, they are remarkably suboptimal for AI: verbose prose forces an LLM to waste valuable context tokens re-parsing implicit structures, wasting tokens and context memory. The answer to this challenge is `report_ai()`, a function that can be triggered via an argument from the main `report()` function. By stripping away the narrative bloat in favour of highly structured, token-efficient formats, `report_ai()` bridges the gap between R and the context window, giving your AI assistant exactly the information it needs in the most effective way possible.
While our standard narrative outputs are excellent for humans, they are remarkably suboptimal for AI: verbose prose forces an LLM to waste valuable context tokens re-parsing implicit structures, wasting tokens and context memory. The answer to this challenge is `report_ai()`, a function that can be triggered via an argument from the main `report()` function. By stripping away the narrative bloat in favor of highly structured, token-efficient formats, `report_ai()` bridges the gap between R and the context window, giving your AI assistant exactly the information it needs in the most effective way possible.

## Basic Usage

Expand Down
Loading