produce_other_report: Produce an upload-compatible txt file from pre-aggregated...

View source: R/produce_other_report.R

produce_other_reportR Documentation

Produce an upload-compatible txt file from pre-aggregated files

Description

Use this function to create a key-value pair uploadable file from your own prepared dataframes, instead of using a different (provided) produce function. Your dataframes must be prepped to match final submission requirements as laid out by IPEDS (or whatever survey you will use this for. Use this function for one survey at a time, and add a separate dataframe for each part to the ... argument. See vignette for more details.

Usage

produce_other_report(..., survey = "MySurvey", part = "AllParts")

Arguments

...

dataframes (one for each survey part, in order)

survey

string with the survey name you'd like in your filename

part

string with the part name (subname) you'd like your file name

Value

txt file on your computer with the title [survey]_[part]_[today's date].txt

Note

You must name the arguments for survey and part if using non-default value. If the arguments are unnamed, the function will assume their values are additional dataframes.

Examples


#With built-in R data
produce_other_report(mtcars[1:5,], iris[1:5,], ToothGrowth[1:5,], survey = 'FakeSurvey')


#Will not execute properly (argument unnamed)
#produce_other_report(mtcars[1:5,], iris[1:5,], ToothGrowth[1:5,], 'FakeSurvey')


AlisonLanski/IPEDSuploadables documentation built on Nov. 2, 2023, 10:54 a.m.