Skip to content
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.

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

Prepare CRAN release #482

Merged
merged 3 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 9 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: report
Type: Package
Title: Automated Reporting of Results and Statistical Models
Version: 0.6.0
Version: 0.6.1
Authors@R:
c(person(given = "Dominique",
family = "Makowski",
Expand Down Expand Up @@ -57,27 +57,29 @@ Depends:
Imports:
bayestestR (>= 0.15.0),
effectsize (>= 1.0.0),
insight (>= 1.0.0),
parameters (>= 0.24.0),
performance (>= 0.12.4),
datawizard (>= 0.13.0),
insight (>= 1.0.1),
parameters (>= 0.24.1),
performance (>= 0.13.0),
datawizard (>= 1.0.0),
stats,
tools,
utils
Suggests:
BayesFactor,
brms,
collapse,
ivreg,
knitr,
lavaan,
lme4,
dplyr,
Formula,
rmarkdown,
rstanarm,
survival,
modelbased,
modelbased (>= 0.9.0),
emmeans,
marginaleffects,
marginaleffects (>= 0.25.0),
RcppEigen,
BH,
testthat (>= 3.2.1)
Expand Down
15 changes: 10 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# report 0.6.1

Bug fixes

* Fixed CRAN check failures.

# report 0.6.0

Minor changes
Expand Down Expand Up @@ -34,9 +40,9 @@ New features

Major Changes

* This release changes the licensing model of `{report}` to an MIT license.
* This release changes the licensing model of `{report}` to an MIT license.

Minor changes
Minor changes

* `report` now supports variables of class `htest` for the Chi2, Friedman test, Fisher's exact test, and Kruskal-Wallis.

Expand Down Expand Up @@ -86,7 +92,7 @@ Minor changes
* Fixes bug whereas the `total` parameter was not respected.

* `report_effectsize` improvement
* For `t.test` (htest) objects, now support the `type` (one of `c("d", "g")`)
* For `t.test` (htest) objects, now support the `type` (one of `c("d", "g")`)
and `rules` (one of `c"cohen1988", "sawilowsky2009", "gignac2016")`)
arguments.

Expand All @@ -106,7 +112,7 @@ Minor changes

BUG FIXES

* Fixed bug with truncated output about confidence interval distribution in
* Fixed bug with truncated output about confidence interval distribution in
`report()`.

# report 0.5.1
Expand Down Expand Up @@ -180,4 +186,3 @@ MAJOR CHANGES
# report 0.3.0

* Initial release of the package.

2 changes: 1 addition & 1 deletion R/report.estimate_contrasts.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#'
#' @inherit report return seealso
#'
#' @examplesIf requireNamespace("modelbased", quietly = TRUE) && requireNamespace("emmeans", quietly = TRUE)
#' @examplesIf all(insight::check_if_installed(c("modelbased", "marginaleffects", "collapse", "Formula"), quietly = TRUE))

Check warning on line 12 in R/report.estimate_contrasts.R

View workflow job for this annotation

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

file=R/report.estimate_contrasts.R,line=12,col=121,[line_length_linter] Lines should not be more than 120 characters. This line is 122 characters.
#' library(modelbased)
#' model <- lm(Sepal.Width ~ Species, data = iris)
#' contr <- estimate_contrasts(model)
Expand All @@ -17,8 +17,8 @@
#' @return An object of class [report()].
#' @export
report.estimate_contrasts <- function(x, ...) {
table <- report_table(x, ...)

Check warning on line 20 in R/report.estimate_contrasts.R

View workflow job for this annotation

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

file=R/report.estimate_contrasts.R,line=20,col=3,[object_overwrite_linter] 'table' is an exported object from package 'base'. Avoid re-using such symbols.
text <- report_text(x, table = table, ...)

Check warning on line 21 in R/report.estimate_contrasts.R

View workflow job for this annotation

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

file=R/report.estimate_contrasts.R,line=21,col=3,[object_overwrite_linter] 'text' is an exported object from package 'graphics'. Avoid re-using such symbols.

as.report(text, table = table, ...)
}
Expand All @@ -38,7 +38,7 @@
report_text.estimate_contrasts <- function(x, table = NULL, ...) {
f_table <- insight::format_table(table)

text <- paste0("The difference between ", x$Level1, " and ", x$Level2, " is ",

Check warning on line 41 in R/report.estimate_contrasts.R

View workflow job for this annotation

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

file=R/report.estimate_contrasts.R,line=41,col=3,[object_overwrite_linter] 'text' is an exported object from package 'graphics'. Avoid re-using such symbols.
ifelse(x$Difference < 0, " negative", "positive"), " and statistically ",
ifelse(x$p < 0.05, "significant", "non-significant"),
" (difference = ", f_table$Difference, ", 95% CI ", f_table$`95% CI`, ", ",
Expand All @@ -46,7 +46,7 @@
collapse = ". "
)

text <- paste("The marginal contrasts analysis suggests the following.", paste(text, collapse = ""))

Check warning on line 49 in R/report.estimate_contrasts.R

View workflow job for this annotation

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

file=R/report.estimate_contrasts.R,line=49,col=3,[object_overwrite_linter] 'text' is an exported object from package 'graphics'. Avoid re-using such symbols.

as.report_text(text)
}
8 changes: 8 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## R CMD check results report 0.6.1

0 errors | 0 warnings | 0 note

## R CMD check results report 0.6.0

0 errors | 0 warnings | 0 note

## R CMD check results report 0.5.9

0 errors | 0 warnings | 0 note
Expand Down
2 changes: 1 addition & 1 deletion man/report.estimate_contrasts.Rd

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

Loading