produce_adm_report

Shortcut function to do all steps to produce a report

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.

Alison Lanski

IPEDSuploadables

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

Shiloh Fling

Edwin Welch

produce_adm_report function

<dl><dt>df</dt>
<dd>A dataframe set up according to the readme</dd>
<dt>ptype</dt>
<dd>(Optional) An integer [1-9] indicating which calculation method to use for test score percentiles. The default value within R and here is 7. To see details, run <code><a href="/link/%3Fquantile?package=IPEDSuploadables&version=3.0.1" data-mini-rdoc="IPEDSuploadables::?quantile">?quantile</a></code> and scroll down to "Type".</dd>
<dt>part</dt>
<dd>A string with what part of the report you want to produce: 'all', 'A', etc.</dd>
<dt>format</dt>
<dd>A string (<code>"uploadable"</code> will produce a properly formatted
upload file. <code>"readable"</code> will produce a csv of the upload file (only
works for one part at a time). <code>"both"</code> will provide both options, but
only works with one part at a time.</dd></dl>

Arguments

Shortcut function to do all steps to produce a report — produce_adm_report

<dl>

<dt>df</dt>
<dd>A dataframe set up according to the readme</dd>


<dt>ptype</dt>
<dd>(Optional) An integer [1-9] indicating which calculation method to use for test score percentiles. The default value within R and here is 7. To see details, run <code><a href='https://rdrr.io/r/stats/quantile.html'>?quantile</a></code> and scroll down to "Type".</dd>


<dt>part</dt>
<dd>A string with what part of the report you want to produce: 'all', 'A', etc.</dd>


<dt>format</dt>
<dd>A string (<code>"uploadable"</code> will produce a properly formatted
upload file. <code>"readable"</code> will produce a csv of the upload file (only
works for one part at a time). <code>"both"</code> will provide both options, but
only works with one part at a time.</dd>

</dl>

produce_adm_report: Shortcut function to do all steps to produce a report

Description

Usage

Value

Arguments