Tweak website (#332)

* remove commented code (and accompanying comments) in report.default, update citation("report"), add life cycle badge, support page, tweak website

* attempt to fix spelling, link rot

.github/SUPPORT.md

@@ -0,0 +1,29 @@
+# Getting help with `{report}`
+
+Thanks for using `{report}`. Before filing an issue, there are a few places
+to explore and pieces to put together to make the process as smooth as possible.
+
+Start by making a minimal **repr**oducible **ex**ample using the
+[reprex](http://reprex.tidyverse.org/) package. If you haven't heard of or used
+reprex before, you're in for a treat! Seriously, reprex will make all of your
+R-question-asking endeavors easier (which is a pretty insane ROI for the five to
+ten minutes it'll take you to learn what it's all about). For additional reprex
+pointers, check out the [Get help!](https://www.tidyverse.org/help/) resource
+used by the tidyverse team.
+
+Armed with your reprex, the next step is to figure out where to ask:
+
+  * If it's a question: start with StackOverflow. There are more people there to answer questions.
+  * If it's a bug: you're in the right place, file an issue.
+  * If you're not sure: let's [discuss](https://github.com/easystats/report/discussions) it and try to figure it out! If your
+    problem _is_ a bug or a feature request, you can easily return here and
+    report it.
+
+Before opening a new issue, be sure to [search issues and pull requests](https://github.com/easystats/report/issues) to make sure the
+bug hasn't been reported and/or already fixed in the development version. By
+default, the search will be pre-populated with `is:issue is:open`. You can
+[edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/)
+(e.g. `is:pr`, `is:closed`) as needed. For example, you'd simply
+remove `is:open` to search _all_ issues in the repo, open or closed.
+
+Thanks for your help!

.gitignore

@@ -51,3 +51,5 @@ revdep/data.sqlite
 /doc/
 /Meta/
 revdep/
+docs
+pkgdown

R/report.default.R

@@ -22,11 +22,6 @@
 #' @return An object of class [report()].
 #' @export
 report.default <- function(x, ...) {
-  # text <- report_text(x, ...)
-  # table <- report_table(x, ...)
-  # as.report(text = text, table = table, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report()"), call. = FALSE)
 }
 
@@ -36,14 +31,6 @@ report.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_effectsize.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- c("large", "medium", "small")
-  # text_short <- c("l", "m", "s")
-  # as.report_effectsize(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_effectsize()"), call. = FALSE)
 }
 
@@ -53,14 +40,6 @@ report_effectsize.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_table.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # table <- data.frame(V1 = c(1, 2), V2 = c("A", "B"), V3 = c(42, 7), stringsAsFactors = FALSE)
-  # table_short <- table[c("V1", "V2")]
-  # as.report_table(table, summary = table_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_table()"), call. = FALSE)
 }
 
@@ -70,14 +49,6 @@ report_table.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_statistics.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- c("(z = 3, p < .05)", "(z = 1, p > 0.09)")
-  # text_short <- c("(z = 3)", "(z = 1)")
-  # as.report_statistics(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_statistics()"), call. = FALSE)
 }
 
@@ -87,14 +58,6 @@ report_statistics.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_parameters.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- c("it's great (z = 3, p < .05)", "it's terrible (z = 1, p > 0.09)")
-  # text_short <- c("it's great (z = 3)", "it's terrible (z = 1)")
-  # as.report_parameters(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_parameters()"), call. = FALSE)
 }
 
@@ -104,14 +67,6 @@ report_parameters.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_intercept.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- "The intercept is at 3 (z = 1, p > 0.09)"
-  # text_short <- "The intercept is at 3 (z = 1)"
-  # as.report_intercept(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_intercept()"), call. = FALSE)
 }
 
@@ -121,14 +76,6 @@ report_intercept.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_model.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- "We fitted a super duper model called the 'easymodel'"
-  # text_short <- "We fitted a super duper model"
-  # as.report_model(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_model()"), call. = FALSE)
 }
 
@@ -138,14 +85,6 @@ report_model.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_random.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- "The random factors are entered as this and that (formula)"
-  # text_short <- "The random factors are entered as this and that"
-  # as.report_random(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_random()"), call. = FALSE)
 }
 
@@ -155,14 +94,6 @@ report_random.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_priors.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- "Priors were specified like this (formula)"
-  # text_short <- "Priors were specified like this"
-  # as.report_priors(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_priors()"), call. = FALSE)
 }
 
@@ -172,14 +103,6 @@ report_priors.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_performance.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  text <- "The model is simply awesome (p < 0.0001)"
-  text_short <- "The model is simply awesome"
-  as.report_performance(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_performance()"), call. = FALSE)
 }
 
@@ -189,14 +112,6 @@ report_performance.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_info.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- "Degrees of freedom were computed using this method, which does that"
-  # text_short <- "Degrees of freedom were computed using this method"
-  # as.report_info(text, summary = text_short, ...)
-
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_info()"), call. = FALSE)
 }
 
@@ -206,20 +121,5 @@ report_info.default <- function(x, ...) {
 #' @rdname report.default
 #' @export
 report_text.default <- function(x, ...) {
-  # Delete the whole function if it's NOT applicable to your model / object.
-  # Don't forget to edit the documentation name above ('rdname report.NEWCLASS')
-  # You can remove the following line and fill it with some (working) code :)
-  # text <- paste(
-  #   report_model(x),
-  #   report_performance(x),
-  #   report_parameters(x),
-  #   report_info(x)
-  # )
-  # text_short <- paste(
-  #   report_performance(x),
-  #   report_parameters(x)
-  # )
-  # as.report_text(text, summary = text_short, ...)
-  # You can uncomment the code above and remove the line below once the functions
   stop(.error_message(x, "report_text()"), call. = FALSE)
 }

README.Rmd

@@ -27,6 +27,7 @@ library(report)
 [![CRAN](http://www.r-pkg.org/badges/version/report)](https://cran.r-project.org/package=report)
 [![downloads](http://cranlogs.r-pkg.org/badges/report)](https://cran.r-project.org/package=report)
 [![R-CMD-check](https://github.com/easystats/datawizard/workflows/R-CMD-check/badge.svg?branch=main)](https://github.com/easystats/datawizard/actions) [![status](https://tinyverse.netlify.com/badge/modelbased)](https://CRAN.R-project.org/package=modelbased)
+[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)
 
 ***"From R to your manuscript"***