Tests, bug fixes, and documentation

- Add rudimentary tests for elements
- Fix check_extension_arg not using valid_inputs parameter
- Documentation for the `with` family of functions
- Dummy readme.md

R/elements.R

@@ -13,13 +13,13 @@
 #' @family elements
 #' @export
 div <- function(..., attr = NULL) {
-    out <- "\n\n:::{%s}\n\n%s\n\n:::\n"
+    rlang::check_dots_unnamed()
 
+    out <- "\n\n:::{%s}\n\n%s\n\n:::\n"
     args <- rlang::dots_list(...)
     attr <- attr %||% "" |>
         paste0(collapse = " ")
     content <- args |>
-        unname() |>
         paste0(collapse = "\n\n")
 
     structure(
@@ -43,13 +43,13 @@ div <- function(..., attr = NULL) {
 #' @family elements
 #' @export
 span <- function(..., attr = NULL) {
-    out <- "[%s]{%s}"
+    rlang::check_dots_unnamed()
 
+    out <- "[%s]{%s}"
     args <- rlang::dots_list(...)
     attr <- attr %||% "" |>
         paste0(collapse = " ")
     content <- args |>
-        unname() |>
         paste0(collapse = " ")
 
     structure(

R/errors.R

@@ -1,6 +1,6 @@
 check_extension_arg <- function(extension, valid_inputs) {
     if (!is.null(extension)) {
-        extension %in% c("left", "right") || rlang::abort(
+        extension %in% valid_inputs || rlang::abort(
             message = c(
                 sprintf("extension argument must be any of: NULL, %s.", paste0(valid_inputs, collapse = ", ")),
                 x = sprintf("supplied extension value: `%s`", extension),

R/quartools-package.R

@@ -1,11 +1,8 @@
-#' quartools: programmatic element creation
-#'
-#' This package allows for the creation of quarto markdown via R function calls.
-#'
-#' @section
-#'
-#' todo
-#'
 #' @keywords internal
-#' @importFrom rlang %||%
 "_PACKAGE"
+
+
+## usethis namespace: start
+#' @importFrom rlang %||%
+## usethis namespace: end
+NULL

R/with.R

@@ -1,11 +1,16 @@
-#' TODO
+#' Temporarily modify page layout
 #' @description
-#' TODO
-#' @param ... todo
-#' @param outset todo
-#' @param extension todo
+#' Create a div block that modifies the current quarto layout column temporarily.
+#'
+#' See [the Quarto documentation for a full list
+#' of available extension options](https://quarto.org/docs/authoring/article-layout.html#available-columns).
+#' @param ... arguments to pass to [quartools::div]
+#' @param outset should the outset affix be applied to the column class?
+#' @param extension affix class to apply to column class
 #' @export
-#' @family page layout functions
+#' @examples
+#' with_body_column("Hello world!")
+#' @rdname page-layout
 with_body_column <- function(..., outset = FALSE, extension = NULL) {
     check_extension_arg(extension, c("left", "right"))
     cls <- ".column-body%s%s"
@@ -19,14 +24,8 @@ with_body_column <- function(..., outset = FALSE, extension = NULL) {
     )
 }
 
-#' TODO
-#' @description
-#' TODO
-#' @param ... todo
-#' @param outset todo
-#' @param extension todo
 #' @export
-#' @family page layout functions
+#' @rdname page-layout
 with_page_column <- function(..., extension = NULL) {
     check_extension_arg(extension, c("left", "right"))
     cls <- ".column-page%s"
@@ -39,14 +38,8 @@ with_page_column <- function(..., extension = NULL) {
     )
 }
 
-#' TODO
-#' @description
-#' TODO
-#' @param ... todo
-#' @param outset todo
-#' @param extension todo
 #' @export
-#' @family page layout functions
+#' @rdname page-layout
 with_screen_inset_column <- function(..., extension = NULL) {
     check_extension_arg(extension, c("left", "right", "shaded"))
     cls <- ".column-screen-inset%s"
@@ -59,14 +52,8 @@ with_screen_inset_column <- function(..., extension = NULL) {
     )
 }
 
-#' TODO
-#' @description
-#' TODO
-#' @param ... todo
-#' @param outset todo
-#' @param extension todo
 #' @export
-#' @family page layout functions
+#' @rdname page-layout
 with_screen_column <- function(..., extension = NULL) {
     check_extension_arg(extension, c("left", "right"))
     cls <- ".column-screen%s"
@@ -79,12 +66,8 @@ with_screen_column <- function(..., extension = NULL) {
     )
 }
 
-#' TODO
-#' @description
-#' TODO
-#' @param ... todo
 #' @export
-#' @family page layout functions
+#' @rdname page-layout
 with_margin_column <- function(...) {
     div(..., attr = ".column-margin")
 }

README.Rmd

@@ -0,0 +1,55 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# quartools
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of quartools is to ...
+
+## Installation
+
+You can install the development version of quartools from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("ElianHugh/quartools")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+library(quartools)
+## basic example code
+```
+
+What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
+
+```{r cars}
+summary(cars)
+```
+
+You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
+
+You can also embed plots, for example:
+
+```{r pressure, echo = FALSE}
+plot(pressure)
+```
+
+In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

README.md

@@ -0,0 +1,52 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# quartools
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of quartools is to …
+
+## Installation
+
+You can install the development version of quartools from
+[GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("ElianHugh/quartools")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(quartools)
+## basic example code
+```
+
+What is special about using `README.Rmd` instead of just `README.md`?
+You can include R chunks like so:
+
+``` r
+summary(cars)
+#>      speed           dist       
+#>  Min.   : 4.0   Min.   :  2.00  
+#>  1st Qu.:12.0   1st Qu.: 26.00  
+#>  Median :15.0   Median : 36.00  
+#>  Mean   :15.4   Mean   : 42.98  
+#>  3rd Qu.:19.0   3rd Qu.: 56.00  
+#>  Max.   :25.0   Max.   :120.00
+```
+
+You’ll still need to render `README.Rmd` regularly, to keep `README.md`
+up-to-date. `devtools::build_readme()` is handy for this.
+
+You can also embed plots, for example:
+
+<img src="man/figures/README-pressure-1.png" width="100%" />
+
+In that case, don’t forget to commit and push the resulting figure
+files, so they display on GitHub and CRAN.