produce_ef1_report: Shortcut function with all steps to provide a Fall Enrollment...

View source: R/produce_ef1_report.R

produce_ef1_reportR Documentation

Shortcut function with all steps to provide a Fall Enrollment report

Description

Shortcut function with all steps to provide a Fall Enrollment report

Usage

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

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.

Value

A txt or csv file at the path of your choice

Examples



#entire report
produce_ef1_report(ef1_students, ef1_retention)

#entire report with optional sections
produce_ef1_report(ef1_students, ef1_retention, include_optional = TRUE)

#one part as csv instead of key-value
produce_ef1_report(ef1_students, part = 'D', format = 'readable')



AlisonLanski/IPEDSuploadables documentation built on Dec. 12, 2022, 5:06 a.m.