Updates for readme

Author: 1beb

R/recontactQuestion.R

@@ -6,7 +6,7 @@
 #' report. If your recontact has been named using a suffix such as _pre, _post
 #' leave that out.
 #' @param suffixes The suffixes of recontact questions, for example _pre, _post
-#' @param labels Formal labels for your recontact period. For example, "Before
+#' @param labels Formal labels for
 #' the election", "After the election".
 #' @param weights A character vector of equal to the length of suffixes. You may
 #' specify a unique weight per recontact period. The default would return
@@ -62,6 +62,7 @@ recontact_toplines <- function(dataset, questions, suffixes, labels,
     ct$results[[question]] <- as.ToplineCategoricalArray(
       ct$results[[p1]],
       ct$results[[p2]],
+      question,
       labels,
       weights
     )
@@ -81,11 +82,13 @@ recontact_toplines <- function(dataset, questions, suffixes, labels,
 #' distinct code to write it to latex.
 #'
 #' @param q1 The results object for the first question
-#' @param q2 The results onject second question
+#' @param q2 The results object for the second question
+#' @param question_alias A string specifying the resulting alias.
 #' @param labels Two character strings used to describe the pre and post waves
 #' @param weights A single alias, list, or NULL
-as.ToplineCategoricalArray <- function(q1, q2, labels = c("Pre", "Post"), weights) {
+as.ToplineCategoricalArray <- function(q1, q2, question_alias = NULL, labels = c("Pre", "Post"), weights) {
 
+  q1$alias <- question_alias
   q1$subnames <- labels
   q1$notes <- paste0(labels, " is weighted by ", weights, collapse = " : ")
   q1$type <- "categorical_array"

R/tex-table.R

@@ -6,7 +6,7 @@
 #' @param df An object from \link{reformatLatexResults}
 #' @param theme A theme object from \link{themeNew}
 #' @param alias The variable's alias
-latexTableBody <- function(df, theme, alias = NULL) {
+latexTableBody <- function(df, theme, question_alias = NULL) {
   # The input "df" object is shaped like this:
   # List of 9
   #  $ top            : NULL
@@ -157,7 +157,7 @@ latexTableBody <- function(df, theme, alias = NULL) {
   # Turn each table in `data` into a LaTeX table string
   if (topline_catarray) {
 
-    if (theme$latex_flip_grids | alias %in% theme$latex_flip_specific_grids) {
+    if (theme$latex_flip_grids | question_alias %in% theme$latex_flip_specific_grids) {
       data$body <- as.data.frame(t(data$body), check.names = FALSE, stringsAsFactors = FALSE)
     }
     # Apparently you can't have any extra table members for these, only "body"
@@ -327,8 +327,9 @@ tableHeader.ToplineVar <- function(var, theme) {
 #' @export
 tableHeader.ToplineCategoricalArray <- function(var, theme) {
   header_row <- newline
-
+  print(var$alias)
   if (theme$latex_flip_grids | var$alias %in% theme$latex_flip_specific_grids) {
+
     col_names <- var$subnames
   } else {
     col_names <- sapply(var$inserts_obj, name)

R/writeLatex.R

@@ -157,7 +157,7 @@ latexReportTables <- function(results, banner, theme) {
 
       # PT: because this is a loop, header is singular (i.e. it's only one table at a time).
       header <- tableHeader(x, theme)
-      body <- sapply(content, latexTableBody, theme = theme, alias = x$alias)
+      body <- sapply(content, latexTableBody, theme = theme, question_alias = x$alias)
 
       footer <- ifelse(
         x$longtable | !theme$topline,

README.md

@@ -39,9 +39,49 @@ toplines_summary <- crosstabs(dataset = ds)
 writeLatex(toplines_summary, filename = "output", pdf = TRUE) # output.pdf will be written 
 ```
 
-
 ![Topline Example from the Example Dataset](vignettes/example-001-topline.png)
 
+### Create a recontact or pre/post Topline
+
+Let's say you have a datasaet where you have asked the same question twice. Once "before" and once "after". `recontact_topline` generates a report that shows these two side by side as if they were a categorical array. Making it easier for reviewers to identify differences over time. 
+
+The function assumes your "before" and "after" questions are named in the same way with a suffix. 
+
+- q1_pre
+- q1_post
+- q3_pre
+- q3_post
+
+```
+# library(crunchtabs)
+# login()
+ds <- loadDataset("Your Recontact Survey")
+rc <- recontact_toplines(
+  ds, 
+  questions = c("q1", "q3"), # The base question name without suffixes
+  suffixes = c("_pre", "_post"), # The suffixes
+  labels = c("Pre", "Post"), # The labels associated with the pre/post
+  weights = c("weight1", "weight2") # The weights associated with the pre/post
+)
+
+writeLatex(rc, pdf = TRUE)
+```
+
+![Recontact Example](vignettes/example-012-recontact-default.png)
+
+Depending on your preferences you can also flip grids if have more categories than waves:
+
+```
+theme <- themeNew(
+  default_theme = themeDefaultLatex(), 
+  latex_flip_specific_grids = c("q1")
+)
+
+writeLatex(rc, theme = theme, pdf = TRUE)
+```
+
+![Recontact Example - Flipped Grid](vignettes/example-013-recontact-flipped-grid.png)
+
 ### Create a Cross Tabulation
 
 The only additional step required for a cross tab report is to create a `banner` object. Then, setting it as the `banner` argument for the `crosstabs` function. Below, we create a cross tabulation report that shows the type of pet(s) respondents own to our survey for every question in the survey. Once you have run the code, we encourage you to open the resulting `output.pdf` file. Inside of the report you will find a cross tabulation of all questions by pet ownership.