final commit before cran?

R/combine.R

@@ -13,22 +13,25 @@
 #' @export
 #'
 #' @examples
+#' # lm example -------------------------------------------
 #' lm_1 = lm(mpg ~ cyl + disp + hp, data = mtcars)
 #' lm_2 = lm(mpg ~ hp + drat + wt, data = mtcars)
 #' lm_3 = lm(mpg ~ ., data = mtcars)
 #' lm_combined = stack_metrics(lm_1, lm_2, lm_3)
-#' print(lm_combined)
+#' lm_combined
 #'
+#' # glm example ------------------------------------------
 #' glm_1 = glm(vs ~ drat + hp, data = mtcars)
 #' glm_2 = glm(vs ~ wt + qsec, data = mtcars)
 #' glm_3 = glm(vs ~ ., data = mtcars)
 #' glm_combined = stack_metrics(glm_1, glm_2, glm_3)
-#' print(glm_combined)
+#' glm_combined
 #'
+#' # lme4 example -----------------------------------------
 #' lmer_1 = lme4::lmer(Sepal.Length ~ (1 | Species), data = iris)
 #' lmer_2 = lme4::lmer(Sepal.Length ~ (1 | Species) + Petal.Length, data = iris)
 #' lmer_combined = stack_metrics(lmer_1, lmer_2)
-#' print(lmer_combined)
+#' lmer_combined
 stack_metrics = function(...) {
 
   models = list(...)
@@ -78,22 +81,30 @@ stack_metrics = function(...) {
 #' [tibble()] for easy comparison across models.
 #'
 #' @param ... lm or glm models to summarize and combine.
-#' @param ci width of confidence, default = 0.95
+#' @param ci width of confidence, default = 0.95.
 #'
 #' @return A [tibble()] with coefficients, confidence intervals, and standard
 #' errors.
 #' @export
 #'
 #' @examples
+#' # multiple lm example ----------------------------------
 #' lm_1 = lm(mpg ~ cyl + disp + hp, data = mtcars)
 #' lm_2 = lm(mpg ~ hp + drat + wt, data = mtcars)
 #' lm_3 = lm(mpg ~ ., data = mtcars)
 #' lm_combined = stack_coeff(lm_1, lm_2, lm_3)
+#' lm_combined
 #'
+#' # sometimes you might just want 1 model's summary ------
+#' single_lm = stack_coeff(lm_1)
+#' single_lm
+#'
+#' # glm example ------------------------------------------
 #' glm_1 = glm(vs ~ drat + hp, data = mtcars)
 #' glm_2 = glm(vs ~ wt + qsec, data = mtcars)
 #' glm_3 = glm(vs ~ ., data = mtcars)
 #' glm_combined = stack_coeff(glm_1, glm_2, glm_3)
+#' glm_combined
 stack_coeff = function(..., ci = 0.95) {
 
   models = list(...)

README.md

@@ -3,6 +3,8 @@
   [![R-CMD-check](https://github.com/WillTirone/modelfactory/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/WillTirone/modelfactory/actions/workflows/R-CMD-check.yaml)
   [![test-coverage](https://github.com/WillTirone/modelfactory/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/WillTirone/modelfactory/actions/workflows/test-coverage.yaml)
   <!-- badges: end -->
+
+<img src="man/figures/logo.png" align="right" height="138" />
 
 # About 
 
@@ -29,20 +31,4 @@ See the [references](https://willtirone.github.io/modelfactory/reference) tab fo
 
 # Contributing 
 
-Contributions are encouraged and welcomed, feel free to submit a PR or open an 
-issue!
-
-# CRAN Submission / TODO
-
-- remove unnecessary README stuff
-- delete inst
-- finish / verify that the functions have roxygen correct
-- add examples to readme
-- add to NEWS.md
-- read release section again and use use_release_issue()
-
-# TODO: 
-  - expects output 
-
-# Change
-  - look at r hub 
+Contributions are encouraged and welcomed, feel free to submit a PR or open an issue!