Shortcut function with all steps to provide a Completions report

produce_com_report(
  df,
  extracips = NULL,
  part = "ALL",
  format = "uploadable",
  ugender = TRUE,
  ggender = TRUE
)

Arguments

df: A dataframe set up according to the readme
extracips: A dataframe set up according to the readme (optional)
part: A string with what part of the report you want to produce: 'all', 'A', etc.
format: A string ("uploadable" will produce a properly formatted upload file. "readable" will produce a csv of the upload file (only works for one part at a time). "both" will provide both options, but only works with one part at a time.
ugender: A boolean: TRUE means you are collecting and able to report "another gender" for undergraduate completers, even if you have no (or few) such students. Set as FALSE if necessary
ggender: A boolean: TRUE means you are collecting and able to report "another gender" for graduate completers, even if you have no (or few) such students. Set as FALSE if necessary

Value

A txt or csv file at the path of your choice

Examples

# \dontshow{
#set temp directory for this example (not necessary for users)
.old_wd <- setwd(tempdir())
# }
# \donttest{
#entire report
produce_com_report(com_students, com_cips)
#> Uploadable results available at C:/Users/alanski/AppData/Local/Temp/Rtmp6NIZ2q/Completions_AllParts_2023-11-01.txt

#one part as csv instead of key-value
produce_com_report(com_students, com_cips, part = "A", format = "readable")
#> Readable results available at  C:/Users/alanski/AppData/Local/Temp/Rtmp6NIZ2q/Completions_PartA_Readable_2023-11-01.csv
# }

# \dontshow{
#reset directory for this example (not necessary for users)
setwd(.old_wd)
# }