Shortcut function with all steps to provide a Fall Enrollment report

produce_ef1_report(
  students,
  retention,
  part = "ALL",
  include_optional = FALSE,
  format = "uploadable",
  ugender = TRUE,
  ggender = TRUE
)

Arguments

students: A dataframe set up according to the readme with student data
retention: A dataframe set up according to the readme with retention data
part: A string with what part of the report you want to produce: 'all', 'A', etc.
include_optional: A boolean flag for whether optional parts should be included
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_ef1_report(ef1_students, ef1_retention)
#> Uploadable results available at C:/Users/alanski/AppData/Local/Temp/Rtmp6NIZ2q/FallEnrollment_AllParts_2023-11-01.txt

#entire report with optional sections
produce_ef1_report(ef1_students, ef1_retention, include_optional = TRUE)
#> Uploadable results available at C:/Users/alanski/AppData/Local/Temp/Rtmp6NIZ2q/FallEnrollment_AllParts_2023-11-01.txt

#one part as csv instead of key-value
produce_ef1_report(ef1_students, part = 'D', format = 'readable')
#> Readable results available at  C:/Users/alanski/AppData/Local/Temp/Rtmp6NIZ2q/FallEnrollment_PartD_Readable_2023-11-01.csv
# }

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