Package: IPEDSuploadables 3.0.1

IPEDSuploadables: Transforms Institutional Data into Text Files for IPEDS Automated Import/Upload

Starting from user-supplied institutional data, these scripts transform, aggregate, and reshape the information to produce key-value pair data files that are able to be uploaded to IPEDS (Integrated Postsecondary Education Data System) through their submission portal <https://surveys.nces.ed.gov/ipeds/>. Starting data specifications can be found in the vignettes. Final files are saved locally to a location of the user's choice. User-friendly readable files can also be produced for purposes of data review and validation.

Authors:Alison Lanski [aut, cre], Shiloh Fling [aut], Edwin Welch [aut]

IPEDSuploadables_3.0.1.tar.gz
IPEDSuploadables_3.0.1.zip(r-4.7)IPEDSuploadables_3.0.1.zip(r-4.6)IPEDSuploadables_3.0.1.zip(r-4.5)
IPEDSuploadables_3.0.1.tgz(r-4.6-any)IPEDSuploadables_3.0.1.tgz(r-4.5-any)
IPEDSuploadables_3.0.1.tar.gz(r-4.7-any)IPEDSuploadables_3.0.1.tar.gz(r-4.6-any)
IPEDSuploadables_3.0.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
IPEDSuploadables/json (API)

# Install 'IPEDSuploadables' in R:
install.packages('IPEDSuploadables', repos = c('https://alisonlanski.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/alisonlanski/ipedsuploadables/issues

Pkgdown/docs site:https://alisonlanski.github.io

Datasets:
  • adm_students - Dummy student-level data for Admissions parts B, C, D, F, G, H
  • com_cips - Dummy cip data for Completions functions
  • com_students - Dummy student data for Completions functions
  • e1d_instr - Dummy aggregated data for 12 Month Enrollment part B
  • e1d_students - Dummy student-level data for 12 Month Enrollment parts A, C, D, E, and F
  • ef1_retention - Dummy student retention data for Fall Enrollment scripts part E
  • ef1_students - Dummy student data for Fall Enrollment scripts
  • gr_students - Dummy student data for the Graduation Rates scripts
  • gr200_students - Dummy student data for Graduation Rates 200 functions
  • hr_staff - Dummy staff data for Human Resources functions
  • om_students - Dummy data for Outcome Measures functions
  • specs_ADM - Table of data requirements for the Admissions starting dataframe
  • specs_COM - Table of data requirements for Completions starting dataframe
  • specs_E1D - Table of data requirements for 12 Month Enrollment starting dataframes
  • specs_EF1 - Table of data requirements for Fall Enrollment starting dataframes
  • specs_GR - Table of data requirements for Graduation Rates starting dataframe
  • specs_GR200 - Table of data requirements for Grad Rates 200 starting dataframe
  • specs_HR - Table of data requirements for HR starting dataframe
  • specs_OM - Table of data requirements for OM starting dataframe

On CRAN:

Conda:

7.69 score 14 stars 58 scripts 312 downloads 70 exports 25 dependencies

Last updated from:5a1fb6f7fe. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK144
source / vignettesOK215
linux-release-x86_64OK155
macos-release-arm64OK146
macos-oldrel-arm64OK151
windows-develOK99
windows-releaseOK108
windows-oldrelOK99
wasm-releaseOK114

Exports:create_dummy_data_admcreate_dummy_data_comcreate_dummy_data_e1dcreate_dummy_data_ef1create_dummy_data_grcreate_dummy_data_gr200create_dummy_data_hrcreate_dummy_data_omget_ipeds_unitidmake_adm_part_Bmake_adm_part_Cmake_adm_part_Dmake_adm_part_Fmake_adm_part_Gmake_adm_part_Hmake_com_part_Amake_com_part_Bmake_com_part_Cmake_com_part_Dmake_com_part_Emake_e1d_part_Amake_e1d_part_Bmake_e1d_part_Cmake_e1d_part_Dmake_e1d_part_Emake_e1d_part_Fmake_ef1_part_Amake_ef1_part_Bmake_ef1_part_Cmake_ef1_part_Dmake_ef1_part_Emake_ef1_part_Fmake_ef1_part_Gmake_ef1_part_Hmake_gr_part_Bmake_gr_part_Cmake_gr_part_Emake_gr200make_hr_part_A1make_hr_part_A2make_hr_part_B1make_hr_part_B2make_hr_part_B3make_hr_part_D1make_hr_part_D2make_hr_part_D3make_hr_part_D4make_hr_part_G1make_hr_part_G2make_hr_part_H1make_hr_part_H2make_om_part_Amake_om_part_Bmake_om_part_Cmake_om_part_Dprep_com_data_frameprep_ef1_data_frameprep_hr_data_frameprep_om_data_frameproduce_adm_reportproduce_com_reportproduce_e1d_reportproduce_ef1_reportproduce_gr_reportproduce_gr200_reportproduce_hr_reportproduce_om_reportproduce_other_reportwrite_reportwrite_report_csv

Dependencies:clicpp11dplyrgenericsgluelifecyclelubridatemagrittrpillarpkgconfigpurrrR6rlangrstudioapistringistringrsvDialogssvGUItibbletidyrtidyselecttimechangeutf8vctrswithr

How to use this package to support your IPEDS reporting
Step 0: Install/Load the package | Step 1: Prep your institutional data | Step 2: Read in your data and produce your IPEDS report | Note about the gender collection updates for 2025-2026 reporting cycle | Notes for specific reports | Step 3: Upload your IPEDS report | Troubleshooting | You need to make a data correction after uploading | IPEDS rejects your upload file or accepts the file but provides an error message | How the package can help you troubleshoot | IPEDS has changed a survey's requirements, but you need to rerun an old report
Rendered fromhowto_overall_ipedsuploadables.Rmdusingknitr::rmarkdown

Last update: 2025-12-05
Started: 2021-10-08

Set up your data for IPEDS Admissions processing
To use the produce_adm_report function, your student admissions data must be in the format described below
Rendered fromsetup_for_admissions.Rmdusingknitr::rmarkdown

Last update: 2025-12-05
Started: 2025-12-04

How to produce other key-value uploads
When to use this How-To | General Process | Data prep example: Admissions (old) | Start with institutional data for applicants | Prepare Part A - General Questions (not from sample data) | Prepare Part B - Student Counts (from sample data) | Part C: Test Scores (from sample data) | Use this package to convert those dataframes into a single uploadable txt file | Upload your final txt file to the IPEDS website
Rendered fromhowto_use_autoformat.Rmdusingknitr::rmarkdown

Last update: 2025-12-04
Started: 2022-01-26

Set up your data for IPEDS 12 Month Enrollment processing
To use the produce_e1d_report function, you must provide two (2) dataframes: one with student enrollment data and one with instructional activity data. | The student enrollment data must be in the format described below | The instructional activity data must be in the format described below
Rendered fromsetup_for_12monthenrollment.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2021-08-13

Set up your data for IPEDS Completions processing
To use the produce_com_report function, your student completions data must be in the format described below | If there are any cip code/degree level/major number combinations that are possible for students to obtain but are NOT represented in this year's student completions data, use the format below to incorporate them into the make_com functions.
Rendered fromsetup_for_completions.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2020-08-28

Set up your data for IPEDS Fall Enrollment processing
The produce_ef1_report function requires 2 separate dataframes, one with row-level students and one with pre-aggregated retention counts. | The dataframes must follow the format described below | Student data requirements | Retention data requirements | Student-faculty ratio
Rendered fromsetup_for_fallenrollment.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2021-09-07

Set up your data for IPEDS GR processing
To use the produce_gr_report function, your student graduation data must be in the format described below
Rendered fromsetup_for_gr.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2021-08-26

Set up your data for IPEDS Graduation Rates 200 processing
To use the produce_gr200_report function, your student graduation data must be in the format described below
Rendered fromsetup_for_gr200.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2021-08-20

Set up your data for IPEDS HR processing
To use the produce_hr_report function, your data must be in the format described below | Note
Rendered fromsetup_for_hr.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2020-07-24

Set up your data for IPEDS OM processing
To use the produce_om_report function, your data must be in the format described below
Rendered fromsetup_for_om.Rmdusingknitr::rmarkdown

Last update: 2024-08-31
Started: 2021-08-20

Readme and manuals

Help Manual

Help pageTopics
Dummy student-level data for Admissions parts B, C, D, F, G, Hadm_students
Shortcut function to turn a dataframe into key-value pairsapply_upload_format
Dummy cip data for Completions functionscom_cips
Dummy student data for Completions functionscom_students
Create dummy data for testing the Admissions functionscreate_dummy_data_adm
Create dummy data for testing the completions functionscreate_dummy_data_com
Create dummy data for testing the completions functionscreate_dummy_data_e1d
Create dummy data for testing the fall enrollment functionscreate_dummy_data_ef1
Create dummy data for testing the Grad Rates functionscreate_dummy_data_gr
Create dummy data for testing the Grad Rates 200 functioncreate_dummy_data_gr200
Create dummy data for testing the hr functionscreate_dummy_data_hr
Create dummy data for testing the outcome measures functionscreate_dummy_data_om
Dummy aggregated data for 12 Month Enrollment part Be1d_instr
Dummy student-level data for 12 Month Enrollment parts A, C, D, E, and Fe1d_students
Dummy student retention data for Fall Enrollment scripts part Eef1_retention
Dummy student data for Fall Enrollment scriptsef1_students
Grab institution's UNITID from supplied data to populate missing-data rowsget_ipeds_unitid
Dummy student data for the Graduation Rates scriptsgr_students
Dummy student data for Graduation Rates 200 functionsgr200_students
Dummy staff data for Human Resources functionshr_staff
'IPEDSuploadables' packageIPEDSuploadables
Make Admissions Part B (First-time student demographics)make_adm_part_B
Make Admissions Part C (First-time SAT/ACT scores)make_adm_part_C
Make Admissions Part D (First-time sex unknown)make_adm_part_D
Make Admissions Part F (Transfer student demographics)make_adm_part_F
Make Admissions Part G (Transfer sex unknown)make_adm_part_G
Make Admissions Part H (Transfer SAT/ACT scores)make_adm_part_H
Make Completions Part Amake_com_part_A
Make Completions Part Bmake_com_part_B
Make Completions Part Cmake_com_part_C
Make Completions Part Dmake_com_part_D
Make Completions Part E (gender details)make_com_part_E
Make 12 Month Enrollment Part Amake_e1d_part_A
Make 12 Month Enrollment Part Bmake_e1d_part_B
Make 12 Month Enrollment Part Cmake_e1d_part_C
Make 12 Month Enrollment Part D (gender details)make_e1d_part_D
Make 12 Month Enrollment Part Emake_e1d_part_E
Make 12 Month Enrollment Part Fmake_e1d_part_F
Make Fall Enrollment Part Amake_ef1_part_A
Make Fall Enrollment Part Bmake_ef1_part_B
Make Fall Enrollment Part Cmake_ef1_part_C
Make Fall Enrollment Part Dmake_ef1_part_D
Make Fall Enrollment Part Emake_ef1_part_E
Make Fall Enrollment Part Fmake_ef1_part_F
Make Fall Enrollment Part Gmake_ef1_part_G
Make Fall Enrollment Part H (Sex Unknown)make_ef1_part_H
Make Graduation Rates Part Bmake_gr_part_B
Make Graduation Rates Part Cmake_gr_part_C
Make Graduation Rates 200make_gr200
Make Human Resources Part A1make_hr_part_A1
Make Human Resources Part A2make_hr_part_A2
Make Human Resources Part B1make_hr_part_B1
Make Human Resources Part B2make_hr_part_B2
Make Human Resources Part B3make_hr_part_B3
Make Human Resources Part D1make_hr_part_D1
Make Human Resources Part D2make_hr_part_D2
Make Human Resources Part D3make_hr_part_D3
Make Human Resources Part D4make_hr_part_D4
Make Human Resources Part G1make_hr_part_G1
Make Human Resources Part G2make_hr_part_G2
Make Human Resources Part H1make_hr_part_H1
Make Human Resources Part H2make_hr_part_H2
Make Outcome Measures Part Amake_om_part_A
Make Outcome Measures Part Bmake_om_part_B
Make Outcome Measures Part Cmake_om_part_C
Make Outcome Measures Part Dmake_om_part_D
Dummy data for Outcome Measures functionsom_students
Some initial recodes for Admissions parts C and Dprep_adm_data_frame
Some initial recoding for Completionsprep_com_data_frame
Some initial recoding for Fall Enrollmentprep_ef1_data_frame
Some initial recoding for Human Resourcesprep_hr_data_frame
Set up extra_awards df for Outcome Measures part B, C, Dprep_om_awards
Some initial recoding for OutcomeMeasuresprep_om_data_frame
Shortcut function to do all steps to produce a reportproduce_adm_report
Shortcut function with all steps to provide a Completions reportproduce_com_report
Shortcut function with all steps to provide a 12 Month Enrollment reportproduce_e1d_report
Shortcut function with all steps to provide a Fall Enrollment reportproduce_ef1_report
Shortcut function with all steps to provide a Graduation Rates reportproduce_gr_report
Shortcut function with all steps to provide a Grad Rates 200 reportproduce_gr200_report
Shortcut function with all steps to provide a Human Resources reportproduce_hr_report
Shortcut function with all steps to provide an Outcome Measures reportproduce_om_report
Produce an upload-compatible txt file from pre-aggregated filesproduce_other_report
Set the path for where the reports will be saved to.set_report_path
Table of data requirements for the Admissions starting dataframespecs_ADM
Table of data requirements for Completions starting dataframespecs_COM
Table of data requirements for 12 Month Enrollment starting dataframesspecs_E1D
Table of data requirements for Fall Enrollment starting dataframesspecs_EF1
Table of data requirements for Graduation Rates starting dataframespecs_GR
Table of data requirements for Grad Rates 200 starting dataframespecs_GR200
Table of data requirements for HR starting dataframespecs_HR
Table of data requirements for OM starting dataframespecs_OM
Write the prepared data to a txt file in key-value formatwrite_report
Write the prepared data to a csv filewrite_report_csv