sr_school_report: Create flexdashboard for a given school or list of schools

In shanejorr/schoolreportr: What the Package Does (One Line, Title Case)

Create flexdashboard for a given school or list of schools

Description

Use the automated template to create a report for a school that provides background information about the school or list of schools. If more than one school is specified, all the data from the data from the schools is aggregated. But, all school must be in the same district.

Usage

sr_school_report(output_filename, nces_num, years, state_abb, grades)

Arguments

output_filename	The filename and path to output the HTML file of the school report. The path is relative to your R root folder in your current session. It should end in '.html'.
nces_num	The NCES number(s) of the school(s) that we want to generate reports for. The numbers should be as strings. Use a vetor of numbers if to aggregate the data of multiple schools within a single district. Use sr_school_nces_numbers() to get a data frame of NCES numbers for each school in a state.
years	The years, as a vector of integers, we want to include in the data.
state_abb	The two letter state abbreviation where the school(s) are located.
grades	A vector of integers representing the grades we want included in the report. If the school does not contain the grades requested, these grades will be ignored. Use sr_school_nces_numbers() to see which grades each school in a state serves. Use -1 for Pre-K and 0 for K.

shanejorr/schoolreportr documentation built on Aug. 7, 2023, 12:25 p.m.