Usage
matchStudents(students, treatment, school.id, match.students,
student.vars, verbose, penalty.qtile, min.keep.pctg)
Arguments
students
a dataframe containing student covariates, with a different row for each student.
treatment
the column name of the binary treatment status indicator in the students dataframe.
school.id
the column name of the unique school ID in the students dataframe.
match.students
logical value. If TRUE, students are matched within school pairs and some students will be excluded. If FALSE, all students will be retained in the matched sample for each school pair.
student.vars
column names of variables in students on which to match students and assess balance of student matches in evaluating match quality.
verbose
a logical value indicating whether detailed output should be printed.
penalty.qtile
a numeric value between 0 and 1 specifying a quantile of the distribution of all student-student matching distances. The algorithm will prefer to exclude treated students rather than form pairs with distances exceeding this quantile.
min.keep.pctg
a minimum percentage of students in the smaller school in a pair which must be retained, even when treated students are excluded.