Shortcut function with all steps to provide a 12 Month Enrollment report
Source:R/produce_e1d_report.R
produce_e1d_report.Rd
Shortcut function with all steps to provide a 12 Month Enrollment report
Usage
produce_e1d_report(
df,
hrs,
part = "ALL",
format = "uploadable",
ugender = TRUE,
ggender = TRUE
)
Arguments
- df
A dataframe set up according to the readme for students
- hrs
A dataframe set up according to the readme for instructional activity
- 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 students, 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 students, even if you have no (or few) such students. Set as FALSE if necessary
Examples
# \donttest{
#entire report
produce_e1d_report(e1d_students, e1d_instr)
#> Uploadable results available at C:/Users/alanski/AppData/Local/Temp/Rtmp0m4l3v/12MonthEnrollment_AllParts_2024-09-02.txt
#one part, as csv instead of key-value file
produce_e1d_report(e1d_students, part = "A", format = "readable")
#> Readable results available at C:/Users/alanski/AppData/Local/Temp/Rtmp0m4l3v/12MonthEnrollment_PartA_Readable_2024-09-02.csv
# }