Skip to content

Commit

Permalink
Include messages while testing signaling conditions (#335)
Browse files Browse the repository at this point in the history
* include messages while testing signaling conditions, update authorships

* update NEWS file
  • Loading branch information
rempsyc authored Feb 4, 2023
1 parent acfc84d commit 042fa33
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 53 deletions.
26 changes: 12 additions & 14 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: report
Title: Automated Reporting of Results and Statistical Models
Version: 0.5.5.4
Version: 0.5.6
Authors@R:
c(person(given = "Dominique",
family = "Makowski",
Expand All @@ -13,26 +13,26 @@ Authors@R:
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0002-8895-3206", Twitter = "@strengejacke")),
person(given = "Mattan S.",
family = "Ben-Shachar",
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0002-4287-4801", Twitter = "@mattansb")),
person(given = "Indrajeet",
family = "Patil",
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0003-1995-6531", Twitter = "@patilindrajeets")),
person(given = "Rémi",
family = "Thériault",
role = c("aut", "cre"),
email = "[email protected]",
comment = c(ORCID = "0000-0003-4315-6788", Twitter = "@rempsyc")),
person(given = "Mattan S.",
family = "Ben-Shachar",
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0002-4287-4801", Twitter = "@mattansb")),
person(given = "Brenton M.",
family = "Wiernik",
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0001-9560-6336", Twitter = "@bmwiernik")),
person(given = "Rémi",
family = "Thériault",
role = c("aut", "cre"),
email = "[email protected]",
comment = c(ORCID = "0000-0003-4315-6788", Twitter = "@rempsyc")),
person(given = "Rudolf",
family = "Siegel",
role = "ctb",
Expand All @@ -59,8 +59,6 @@ Imports:
stats,
tools,
utils
Remotes:
easystats/effectsize
Suggests:
brms,
ivreg,
Expand All @@ -76,7 +74,7 @@ VignetteBuilder:
knitr
Encoding: UTF-8
Language: en-US
RoxygenNote: 7.2.3.9000
RoxygenNote: 7.2.3
Config/testthat/edition: 3
Config/Needs/website:
rstudio/bslib,
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# report (development version)
# report 0.5.6

Breaking Changes

Expand Down
15 changes: 8 additions & 7 deletions R/cite_easystats.R
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ cite_easystats <- function(packages = "easystats",
cit_packages <- sprintf(
"(%s)",
toString(c(
easystats = sprintf("L\u00fcdecke et al., 2019/2022%s", letters_ludeckePackages[1]),
easystats = sprintf("L\u00fcdecke et al., 2019/2023%s", letters_ludeckePackages[1]),
insight = sprintf("L\u00fcdecke et al., 2019, 2019/2022%s", letters_ludeckePackages[2]),
datawizard = sprintf("Makowski et al., 2021/2022%s", letters_makowskiPackages[1]),
bayestestR = sprintf("Makowski et al., 2019, 2019/2022%s", letters_makowskiPackages[2]),
Expand All @@ -118,7 +118,7 @@ cite_easystats <- function(packages = "easystats",
"L\u00fcdecke et al., 2021%s, 2019/2022%s",
letters_ludeckeArticles[2], letters_ludeckePackages[5]
),
report = sprintf("Makowski et al., 2021/2022%s", letters_makowskiPackages[5])
report = sprintf("Makowski et al., 2021/2023%s", letters_makowskiPackages[5])
)[packages])
)
} else if (format == "markdown") {
Expand Down Expand Up @@ -180,9 +180,10 @@ cite_easystats <- function(packages = "easystats",
sort(unlist(list(
easystats = sprintf(
paste(
"L\u00fcdecke, D., Makowski, D., Ben-Shachar, M. S., Patil, I., & Wiernik, B. M. (2022).",
"L\u00fcdecke, D., Makowski, D., Ben-Shachar, M. S., Patil, I., Wiernik, B. M.,",
"Bacher, Etienne, & Th\U00E9riault, R. (2023).",
"easystats: Streamline model interpretation, visualization, and reporting%s [R package].",
"https://github.com/easystats/easystats (Original work published 2019)"
"https://easystats.github.io/easystats/ (Original work published 2019)"
),
ifelse(installed_packages["easystats"] == "", "", paste0(" (", installed_packages["easystats"], ")"))
),
Expand Down Expand Up @@ -316,10 +317,10 @@ cite_easystats <- function(packages = "easystats",
),
report = sprintf(
paste(
"Makowski, D., L\u00fcdecke, D., Ben-Shachar, M. S., Patil, I.,",
"Wiernik, B. M., & Th\U00E9riault, R. (2022).",
"Makowski, D., L\u00fcdecke, D., Patil, I., Th\U00E9riault, R., Ben-Shachar, M. S.,",
"& Wiernik, B. M. (2023).",
"report: Automated reporting of results and statistical models (%s) [R package].",
"https://CRAN.R-project.org/package=report (Original work published 2021)"
"https://easystats.github.io/easystats/ (Original work published 2021)"
),
installed_packages["report"]
)
Expand Down
6 changes: 3 additions & 3 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
bibentry(bibtype = "Article",
title = "Automated Results Reporting as a Practical Tool to Improve Reproducibility and Methodological Best Practices Adoption",
author=c(person("Dominique", "Makowski"), person("Daniel", "Lüdecke"), person("Mattan S.", "Ben-Shachar"), person("Indrajeet", "Patil"), person("Brenton M.", "Wiernik"), person("Rémi", "Thériault")),
year = 2021,
author=c(person("Dominique", "Makowski"), person("Daniel", "Lüdecke"), person("Indrajeet", "Patil"), person("Rémi", "Thériault")), person("Mattan S.", "Ben-Shachar"), person("Brenton M.", "Wiernik"),
year = 2023,
journal = "CRAN",
url = "https://easystats.github.io/report/",
textVersion = paste("Makowski, D., Ben-Shachar, M.S., Patil, I., Lüdecke, D., & Thériault, R. (2020). Automated Results Reporting as a Practical Tool to Improve Reproducibility and Methodological Best Practices Adoption. CRAN.", "Available from https://easystats.github.io/report/", "doi: .", sep=" "),
textVersion = paste("Makowski, D., Lüdecke, D., Patil, I., Thériault, R., Ben-Shachar, M.S., & Wiernik, B.M. (2023). Automated Results Reporting as a Practical Tool to Improve Reproducibility and Methodological Best Practices Adoption. CRAN.", "Available from https://easystats.github.io/report/", "doi: .", sep=" "),
mheader = "To cite in publications use:")
16 changes: 8 additions & 8 deletions inst/easystats_bib.bib
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ @software{datawizardPackage
@software{easystatsPackage,
title = {{{easystats}}: Streamline Model Interpretation, Visualization, and Reporting},
shorttitle = {{{easystats}}},
author = {L\"udecke, Daniel and Makowski, Dominique and Ben-Shachar, Mattan S. and Patil, Indrajeet and Wiernik, Brenton M.},
date = {2022-03-27T22:06:06Z},
author = {L\"udecke, Daniel and Makowski, Dominique and Ben-Shachar, Mattan S. and Patil, Indrajeet and Wiernik, Brenton M. and Bacher, Etienne and Thériault, Rémi },
date = {2023-02-04T22:06:06Z},
origdate = {2019-01-28T10:39:29Z},
url = {https://github.com/easystats/easystats},
urldate = {2022-03-28},
url = {https://easystats.github.io/easystats/},
urldate = {2023-02-04},
version = {%s}
}

Expand Down Expand Up @@ -201,11 +201,11 @@ @software{performancePackage
@software{reportPackage,
title = {{{report}}: Automated Reporting of Results and Statistical Models},
shorttitle = {{{report}}},
author = {Makowski, Dominique and L\"udecke, Daniel and Ben-Shachar, Mattan S. and Patil, Indrajeet and Wiernik, Brenton M. and Thériault, Rémi},
date = {2022-02-22},
author = {Makowski, Dominique and L\"udecke, Daniel and Patil, Indrajeet and Thériault, Rémi and Ben-Shachar, Mattan S. and Wiernik, Brenton M.},
date = {2023-02-04},
origdate = {2021-04-15},
url = {https://CRAN.R-project.org/package=report},
urldate = {2022-01-28},
url = {https://easystats.github.io/report/},
urldate = {2023-02-04},
abstract = {The aim of the 'report' package is to bridge the gap between R's output and the formatted results contained in your manuscript. This package converts statistical models and data frames into textual reports suited for publication, ensuring standardization and quality in results reporting.},
version = {%s}
}
Expand Down
38 changes: 21 additions & 17 deletions inst/easystats_bib.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,9 @@ references:

- id: easystatsPackage
accessed:
- year: 2022
month: 3
day: 28
- year: 2023
month: 2
day: 4
author:
- family: Lüdecke
given: Daniel
Expand All @@ -192,12 +192,16 @@ references:
given: Indrajeet
- family: Wiernik
given: Brenton M.
- family: Bacher
given: Etienne
- family: Thériault
given: Rémi
citation-key: easystatsPackage
genre: R package
issued:
- year: 2022
month: 3
day: 27
- year: 2023
month: 2
day: 4
original-date:
- year: 2019
month: 1
Expand All @@ -207,7 +211,7 @@ references:
visualization, and reporting
title-short: <span class="nocase">easystats</span>
type: software
URL: https://github.com/easystats/easystats
URL: https://easystats.github.io/easystats/
version: %s

- id: effectsizeArticle
Expand Down Expand Up @@ -555,28 +559,28 @@ references:
statistical models and data frames into textual reports suited for
publication, ensuring standardization and quality in results reporting.
accessed:
- year: 2022
month: 1
day: 28
- year: 2023
month: 2
day: 4
author:
- family: Makowski
given: Dominique
- family: Lüdecke
given: Daniel
- family: Ben-Shachar
given: Mattan S.
- family: Patil
given: Indrajeet
- family: Wiernik
given: Brenton M.
- family: Thériault
given: Rémi
- family: Ben-Shachar
given: Mattan S.
- family: Wiernik
given: Brenton M.
citation-key: reportPackage
genre: R package
issued:
- year: 2022
- year: 2023
month: 2
day: 22
day: 04
original-date:
- year: 2021
month: 4
Expand All @@ -586,7 +590,7 @@ references:
statistical models
title-short: <span class="nocase">report</span>
type: software
URL: https://CRAN.R-project.org/package=report
URL: https://easystats.github.io/easystats/
version: %s

- id: seeArticle
Expand Down
2 changes: 1 addition & 1 deletion man/report-package.Rd

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.aov.R
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ test_that("report.aov", {

model <- aov(Sepal.Length ~ Species * Cat1 + Error(Cat2), data = data)
r5 <- report(model, verbose = FALSE)
expect_warning(report(model))
expect_warning(report(model), "non-finite")
expect_equal(
c(
ncol(as.report_table(r5, summary = TRUE)),
Expand Down
2 changes: 1 addition & 1 deletion tests/testthat/test-report.data.frame.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ test_that("report.numeric", {
expect_null(summary(as.data.frame(r))$Mean)
expect_null(summary(as.data.frame(r))$Min)
expect_null(summary(as.data.frame(r))$MAD)
expect_warning(report(c(0, 0, 0, 1, 1)))
expect_warning(report(c(0, 0, 0, 1, 1)), "factor")
})


Expand Down

0 comments on commit 042fa33

Please sign in to comment.