dataedu: Package for Data Science in Education Using R

#' Foundational Skills Data
#'
#' Dataset on Massachusetts public schools
#'
#' @name ma_data_init
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @keywords datasets
#' @examples
#'
#' str(dataedu::ma_data_init)
"ma_data_init"

#' Walkthrough 01 - Course Data
#'
#' Dataset on points earned out of points possible
#' on more than 29,000 class assignments
#'
#'
#' @name course_data
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source John Ranellucci and Joshua Rosenberg
#' @keywords datasets
#' @examples
#'
#' str(dataedu::course_data)
"course_data"

#' Walkthrough 01 - Pre-Survey
#'
#' Walkthrough 01 - Dataset on students' motivation administered before
#' the start of those students' online science courses
#'
#'
#' @name pre_survey
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source John Ranellucci and Joshua Rosenberg
#' @keywords datasets
#' @examples
#'
#' str(dataedu::pre_survey)
"pre_survey"

#' Walkthrough 01 - Course Minutes
#'
#' Walkthrough 01 - Dataset on log-trace data from the number of minutes
#' students spend on the course learning management system
#' for online science courses
#'
#'
#' @name course_minutes
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source John Ranellucci and Joshua Rosenberg
#' @keywords datasets
#' @examples
#'
#' str(dataedu::course_minutes)
"course_minutes"

#' Walkthrough 01 - Student Motivation (Processed and With Text)
#'
#' Walkthrough 01 - Processed dataset (for modeling with random forests)
#' from students on their motivation and achievement in
#' online science classes.
#'
#'
#' @name sci_mo_with_text
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source John Ranellucci and Joshua Rosenberg
#' @keywords datasets
#' @examples
#'
#' str(dataedu::sci_mo_with_text)
"sci_mo_with_text"

#' Walkthrough 01 - Student Motivation (Processed)
#'
#' Walkthrough 01 - Processed dataset (for modeling with multi-level models)
#' from students on their motivation and achievement in
#' online science classes
#'
#'
#' @name sci_mo_processed
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source John Ranellucci and Joshua Rosenberg
#' @keywords datasets
#' @examples
#'
#' str(dataedu::sci_mo_processed)
"sci_mo_processed"

#' Walkthrough 12 - Tweet Data
#'
#' Walkthrough 12 - Tweet dataset gathered from hashtag tidytuesday
#'
#'
#' @name tt_tweets
#' @docType data
#' @format Dataset of class \code{list}.
#' @source Twitter and TidyTuesday <https://thomasmock.netlify.com/post/tidytuesday-a-weekly-social-data-project-in-r/>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::tt_tweets)
"tt_tweets"

#' Walkthrough 03 - Tabulizer Output from Race PDF
#'
#' Walkthrough 03 - RDS file with tabulizer output
#' from the Race PDF.
#' 
#'
#' @name race_pdf
#' @docType data
#' @format Dataset of class \code{list}.
#' @source Minneapolis Public Schools <https://mpls.k12.mn.us/>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::race_pdf)
"race_pdf"


#' Walkthrough 03 - Tabulizer Output from FRPL PDF
#'
#' Walkthrough 03 - RDS file with tabulizer output
#' from the FRPL PDF.
#' 
#'
#' @name frpl_pdf
#' @docType data
#' @format Dataset of class \code{list}.
#' @source Minneapolis Public Schools <https://mpls.k12.mn.us/>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::frpl_pdf)
"frpl_pdf"

#' Walkthrough 03 - Merged Ethnicity and FRPL District Data
#'
#' Walkthrough 03 - Dataset with processed district data with
#' both FRPL and ethnicity data
#'
#'
#' @name district_merged_df
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source Minneapolis Public Schools <https://mpls.k12.mn.us/>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::district_merged_df)
"district_merged_df"

#' Walkthrough 03 - Merged and Tidy Ethnicity and FRPL District Data
#'
#' Walkthrough 03 - Dataset with processed district data with
#' both FRPL and ethnicity data in tidy format
#'
#'
#' @name district_tidy_df
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source Minneapolis Public Schools <https://mpls.k12.mn.us/>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::district_tidy_df)
"district_tidy_df"

#' Walkthrough 04 - Students with Disabilities Counts - 2012
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2012
#'
#'
#' @name bchildcountandedenvironments2012
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2012)
"bchildcountandedenvironments2012"

#' Walkthrough 04 - Students with Disabilities Counts - 2012
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2012
#'
#'
#' @name bchildcountandedenvironments2012
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2012)
"bchildcountandedenvironments2012"

#' Walkthrough 04 - Students with Disabilities Counts - 2013
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2013
#'
#'
#' @name bchildcountandedenvironments2013
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2013)
"bchildcountandedenvironments2013"

#' Walkthrough 04 - Students with Disabilities Counts - 2014
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2014
#'
#'
#' @name bchildcountandedenvironments2014
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2014)
"bchildcountandedenvironments2014"

#' Walkthrough 04 - Students with Disabilities Counts - 2015
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2015
#'
#'
#' @name bchildcountandedenvironments2015
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2015)
"bchildcountandedenvironments2015"

#' Walkthrough 04 - Students with Disabilities Counts - 2016
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2016
#'
#'
#' @name bchildcountandedenvironments2016
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2016)
"bchildcountandedenvironments2016"

#' Walkthrough 04 - Students with Disabilities Counts - 2017-18
#'
#' Walkthrough 04 - Dataset containing students with disabilities
#' longitudinal enrollment counts in 2017-18
#'
#'
#' @name bchildcountandedenvironments2017_18
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::bchildcountandedenvironments2017_18)
"bchildcountandedenvironments2017_18"

#' Walkthrough 04 - Students with Disabilities Counts - Combined List
#'
#' Walkthrough 04 - List containing students with disabilities
#' longitudinal enrollment counts from 2012-18
#'
#'
#' @name all_files
#' @docType data
#' @format Dataset of class \code{list}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::all_files)
"all_files"

#' Walkthrough 04 - Students with Disabilities Counts - Combined Data Frame
#'
#' Walkthrough 04 - Combined data frame containing students with disabilities
#' longitudinal enrollment counts from 2012-18
#'
#'
#' @name child_counts
#' @docType data
#' @format Dataset of class \code{tibble}.
#' @source US Department of Education <https://www2.ed.gov/programs/osepidea/618-data/state-level-data-files/index.html>
#' @keywords datasets
#' @examples
#'
#' str(dataedu::child_counts)
"child_counts"

#' All packages used in Data Science in Education Using R
#'
#' @name dataedu_packages
#' @format A character vector
#' @export dataedu_packages
#'
dataedu_packages <-
  c(
    "apaTables",
    "caret",
    "dummies",
    "e1071",
    "ggraph",
    "here",
    "janitor",
    "lme4",
    "lubridate",
    "performance",
    "ranger",
    "readxl",
    "rtweet",
    "randomNames",
    "sjPlot",
    "textdata",
    "tidygraph",
    "tidylog",
    "tidyverse",
    "tidytext"
  )