R/layout_data.R

In almartin82/njschooldata: a simple interface for accessing NJ DOE school data in R

#' NJASK layout metadata
#'
#' A processed R version of the 'File Layout' for the most current (2008-present)
#' NJASK.  Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/14/njask5/
"layout_njask"


#' NJASK layout metadata, 2004 test
#'
#' A processed R version of the 'File Layout' for the 2004
#' NJASK (only offered for grades 3 and 4).   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/2005/njask3/
"layout_njask04"


#' NJASK layout metadata, 2005 test
#'
#' A processed R version of the 'File Layout' for the 2005
#' NJASK (only offered for grades 3 and 4).   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/2006/njask3/
"layout_njask05"


#' NJASK layout metadata, 2006 grade 3 and 4 test
#'
#' A processed R version of the 'File Layout' for the 2006
#' NJASK, elementary (gr 3 and 4) version.   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/2007/njask3/
"layout_njask06gr3"


#' NJASK layout metadata, 2006 grade 5-7 test
#'
#' A processed R version of the 'File Layout' for the 2006
#' NJASK, middle school (gr 5, 6, 7) version.   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/2007/njask57/
"layout_njask06gr5"


#' NJASK layout metadata, 2007 and 2008 elementary test
#'
#' A processed R version of the 'File Layout' for the 2007 and 2008
#' NJASK, elementary (gr 3 and 4) version.   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/2008/njask3/
"layout_njask07gr3"


#' NJASK layout metadata, 2009 test, 2007-8 gr 5+ test
#'
#' A processed R version of the 'File Layout' for the 2009 NJASK   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.state.nj.us/education/schools/achievement/2009/njask3/
"layout_njask09"


#' GEPA layout metadata, 2004 - 2007 assessment
#'
#' A processed R version of the 'File Layout' for the 2004-2007
#' GEPA.   
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.nj.gov/education/schools/achievement/2005/gepa/
"layout_gepa"


#' HSPA layout metadata, 2004 - 2010 assessment
#'
#' A processed R version of the 'File Layout' for the 2004-2010 HSPA.
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.nj.gov/education/schools/achievement/2005/hspa/
"layout_hspa10"


#' HSPA layout metadata, 2011 - present
#'
#' A processed R version of the 'File Layout' for the 2011-present HSPA
#' Original file is in .xls format on NJDOE website
#'
#' @format
#' \describe{
#' \item{field_start_position}{field_start_position}
#' \item{field_end_position}{field_end_position}
#' \item{field_length}{field_length}
#' \item{data_type}{data_type}
#' \item{description}{description}
#' \item{comments}{comments}
#' \item{valid_values}{valid_values}
#' \item{spanner1}{spanner1}
#' \item{spanner2}{spanner2}
#' \item{final_name}{final_name}
#' #' }
#' @source NJDOE website - eg the 'File Layout' link on
#' http://www.nj.gov/education/schools/achievement/14/hspa/
"layout_hspa"