A few things to note:
#official install from CRAN
install.packages("IPEDSuploadables")
#development install from the github repo
#use this if you want to pull in changes before they reach cran or need to use other code branches
#development install option 1
remotes::install_github("AlisonLanski/IPEDSuploadables")
#development install option 2
devtools::install_github("AlisonLanski/IPEDSuploadables")The package requires specific column names and values to work correctly. Each IPEDS report has a vignette that spells out requirements and also has sample data you can examine.
To create files for non-supported reports, see How to produce other key-value uploads
| IPEDS Report | Required Dataframes | Sample Data |
|---|---|---|
| 12 Month Enrollment | students & instructional activity | e1d_students, e1d_instr |
| Completions | students & extra cips | com_students, com_cips |
| Fall Enrollment | students & retention aggregate | ef1_students, ef1_retention |
| Graduation Rates | students | gr_students |
| Graduation Rates 200 | students | gr200_students |
| Human Resources | staff | hr_staff |
| Outcome Measures | students | om_students |
You can call the sample data as desired to explore it
#dataframe of student information for 12 month enrollment
head(e1d_students)
#> Unitid StudentId IsFullTime IsFirstTime IsTransfer IsDegreeCertSeeking
#> 1 999999 100 1 1 0 1
#> 2 999999 101 1 1 0 0
#> 3 999999 102 1 1 0 1
#> 4 999999 103 1 1 0 0
#> 5 999999 104 1 1 0 1
#> 6 999999 105 1 1 0 0
#> StudentLevel IsHighSchool IsDual RaceEthnicity Sex DistanceEdAll
#> 1 Undergraduate 0 0 1 1 0
#> 2 Undergraduate 0 0 1 2 0
#> 3 Undergraduate 0 0 1 2 0
#> 4 Undergraduate 0 0 1 1 0
#> 5 Undergraduate 0 0 1 1 0
#> 6 Undergraduate 0 0 1 2 0
#> DistanceEdSome GenderDetail
#> 1 1 1
#> 2 1 2
#> 3 1 2
#> 4 1 1
#> 5 1 1
#> 6 0 2Each IPEDS report has a single function which will produce all required sub-parts in a single file for upload.
Example:
A message will be display the location of your file when it has been processed.
The category “Another Gender” has been removed from all surveys.
IPEDS changed collection of Gender Detail to only include “Unknown”.
Therefore, the starting data requirements, sample data, and scripts have
been updated to remove the “Another Gender” option from the
GenderDetail column, and no functions require the
ugender or ggender flags
Completions, 12 Month Enrollment, and Fall Enrollment still DO
require reporting on “unknown sex”. This means you continue to need the
GenderDetail column, but should limit yourself to values of
1, 2, and 3. Note: anything other than 1 and 2 will be recoded
to 3 within the package. Graduation Rates and other surveys
continue to have no gender detail reporting.
Because “another gender” is no longer being collected, the
ugender and ggender arguments in the
produce functions are no longer necessary. You can omit
them entirely in your code. If you keep them, they will be ignored.
IPEDS has also adjusted language in the instruction files to replace “Gender” with “Sex” and related terminology. We have generally only made updates to the package if IPEDS changes would break the package in some way. Column names in the data you prepare have not been adjusted, nor has our language in the documentation. The choice for minimal changes on our end was simply for expediency – the fewer changes either of us have to implement, the better!
Example:
Completions
Fall Enrollment
Your student-faculty ratio number is collected via pop-up box. Type a whole number when prompted.
The main function auto-detects the IPEDS submission year and
adjusts the sections of cip-based enrollment, student age, and student
residence state appropriately to be in or out of your report. If you
would like to report data in optional years, change the
include_optional flag to TRUE.
Human Resources
Admissions
Navigate to the IPEDS submission portal and log in.
Select the appropriate report (for example: “12 Month Enrollment”), select “key-value pair”, then browse to your .txt file and upload.
Click through the survey screens to review results and verify submission accuracy
Continue your standard process to check edits, enter metadata, lock, and submit the survey.
Update your base data, rerun the package function, and re-upload to
IPEDS. You can upload as many times as you want to any particular
survey.
Your keyholder may be able to edit directly in the website, but this
method is not recommended since it is not reproducible.
If you verify that your data and dataframe(s) are correct, but IPEDS still shows incorrect aggregation, please contact the package authors by adding a GitHub issue or by emailing (if you search online for Alison Lanski and Notre Dame, you can get to a valid email address). We can provide the quickest help if you share an example with sample data, expected output, and actual output.
Common issues include:
For example, IPEDS wants all previous CIP/Award Level combinations reported on the current completions upload file. If you have no students in those categories, add any flagged CIP/Award combinations to your extra_cips dataframe, rerun, and reupload to remove this error message
A few functions have built-in data quality checks which will alert you of disallowed values. We are working to add more automated checks.
If you want to examine a single report sub-part in depth, you can create a separate text file with only those values.
Example:
You can also produce a csv version of the part’s text file, for more readable output (still using IPEDS upload-required column names and values)
Example:
At the end of every IPEDS collection cycle, that year’s package code will be saved into a branch on GitHub. To use an old version, install the package from the branch.
#install, picking an acceptable year range
devtools::install_github(repo = "AlisonLanski/IPEDSuploadables", ref = "reporting_year_2022-2023")When you have finished running your code, reinstall the current version of the package by removing the “ref” argument.