R/sheet.R

Defines functions sheet

Documented in sheet

#' sheet
#' This function generates creates a list of information need to be added to a sheet - will be used in conjunction with wb()
#' @param tables The input analytical dataset of type data frame.
#' @param subtitle A vector of all the dependent variable names. No need to dummify variables.
#' @param sheetname A vector of all the continuous variable names
#' @param stack If there are multiple tables need to be added to a single sheet, how they're stacked is determined by this argument. "sideways" add tables right to the previous one and "below" add tables one below the other. The default is "sideways".
#' @export sheet
#' @return A list containing the tables, subtitle and sheetname

sheet <- function(tables = list(),
                  subtitle = "Subtitle",
                  sheetname = "sheet1",
                  stack = "sideways") {
  return(list(tables, subtitle, sheetname,stack))

}
nivesh22/descriptive documentation built on Jan. 22, 2020, 8:03 p.m.