release v0.3.0

.Rbuildignore

@@ -5,3 +5,6 @@
 ^docs$
 ^pkgdown$
 ^\.github$
+^README\.Rmd$
+^doc$
+^Meta$

.gitignore

@@ -5,3 +5,6 @@
 .DS_Store
 .quarto
 docs
+inst/doc
+/doc/
+/Meta/

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: lighthouse.codebook
 Title: Summarize Datasets for Lighthouse Institute Projects
-Version: 0.2.3
+Version: 0.3.0
 Authors@R: c(
     person("Casey", "Sarapas", 
            email = "ccsarapas@chestnut.org", 
@@ -35,3 +35,7 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.3
 URL: https://github.com/ccsarapas/lighthouse.codebook, https://ccsarapas.github.io/lighthouse.codebook/
 BugReports: https://github.com/ccsarapas/lighthouse.codebook/issues
+Suggests: 
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr

NAMESPACE

@@ -4,7 +4,9 @@ S3method(nan_to_na,data.frame)
 S3method(nan_to_na,default)
 S3method(nan_to_na,list)
 export(cb_create)
+export(cb_create_options)
 export(cb_create_redcap)
+export(cb_create_redcap_options)
 export(cb_create_spss)
 export(cb_get_data)
 export(cb_summarize_categorical)

NEWS.md

@@ -1,3 +1,63 @@
+# lighthouse.codebook 0.3.0
+
+## Added
+
+* Added options to `cb_write()` to show grouping variables for categorical summaries 
+  in rows (which was previously only possible for numeric summaries.) `cb_write()` 
+  now includes three arguments for showing some or all grouping variables in rows:
+  `group_rows` controls both numeric and categorical summaries, while `group_rows_numeric` 
+  and `group_rows_categorical` control numeric and categorical summaries, respectively.
+
+* Added an introductory vignette (see `vignette("lighthouse-codebook")`).
+
+* Expanded the README.
+
+## Changed
+
+* `cb_create()`, `cb_create_spss()`, and `cb_create_redcap()` now use a single `.options` 
+  argument for less commonly used settings. Arguments for those settings have been 
+  moved into an options object created with `cb_create_options()` or `cb_create_redcap_options()`.
+  ```r
+  # previously
+  cb <- cb_create(
+    dat, metadata = metadata, 
+    .rmv_html = FALSE, .include_r_classes = TRUE
+  )
+
+  # now
+  cb <- cb_create(
+    dat, metadata = metadata, 
+    .options = cb_create_options(rmv_html = FALSE, include_r_classes = TRUE)
+  )
+
+  ### `cb_create_spss()` also uses `cb_create_options()`
+  # previously
+  cb_spss <- cb_create_spss(dat_spss, .rmv_line_breaks = FALSE)
+
+  # now
+  cb_spss <- cb_create_spss(
+    dat_spss, 
+    .options = cb_create_options(rmv_line_breaks = FALSE)
+  )
+
+  ### Note that `cb_create_redcap()` has its own options constructor
+  # previously
+  cb <- cb_create_redcap(
+    dat_rc, metadata = metadata_rc, 
+    .form = NULL, .rmv_html = FALSE
+  )
+
+  # now
+  cb <- cb_create_redcap(
+    dat_rc, metadata = metadata_rc, 
+    .options = cb_create_redcap_options(form = NULL, rmv_html = FALSE)
+  )
+  ```
+
+## Removed
+
+* The `format = "values"` option in `cb_get_data()` has been removed (see #26).
+
 # lighthouse.codebook 0.2.3
 
 * `cb_create_spss()` now accepts `.rmv_html` and `.rmv_line_breaks` arguments, consistent