updating documentation.

kippchicago · Mar 24, 2015 · 55c72f1 · 55c72f1
1 parent 673f778
commit 55c72f1
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/R/school_growth_percentile.R b/R/school_growth_percentile.R
@@ -436,7 +436,7 @@ equate_fall_to_spring <- function(growth_data=map_matched,
 #' @title Finds student national percentile rank 
 #'
 #' @description \code{get_test_percentile} looks up a student's national 
-#' percentile rank from \code{\student_status_norms_2011_dense_extended}.
+#' percentile rank from \code{student_status_norms_2011_dense_extended}.
 #'
 #' @param measurementscale the test subject.
 #' @param season the test season, which is one of "Fall", "Winter", or "Spring".

diff --git a/R/sqrp_levels.R b/R/sqrp_levels.R
@@ -330,11 +330,13 @@ calc_access_points <- function(pct){
 #' @description \code{calc_5essentials_points} calculates  points given 
 #' 5Essentials Rating
 #' @details `rating` must be a characteer vector with one of the following:
-#' "WO" = Well Organized
-#' "O" = Organized
-#' "MO" = Mostly Organized
-#' "PO" = Partially Organized
-#' "NYO" = Not Yet Organized
+#' \itemize{
+#' \item "WO" = Well Organized
+#' \item "O" = Organized
+#' \item "MO" = Mostly Organized
+#' \item "PO" = Partially Organized
+#' \item "NYO" = Not Yet Organized
+#' }
 #' 
 #' @param rating 5Esstianls rating as character vectors:
 #' 

diff --git a/man/calc_5essentials_points.Rd b/man/calc_5essentials_points.Rd
@@ -18,10 +18,12 @@ a single element numeric vector
 }
 \details{
 `rating` must be a characteer vector with one of the following:
-"WO" = Well Organized
-"O" = Organized
-"MO" = Mostly Organized
-"PO" = Partially Organized
-"NYO" = Not Yet Organized
+\itemize{
+\item "WO" = Well Organized
+\item "O" = Organized
+\item "MO" = Mostly Organized
+\item "PO" = Partially Organized
+\item "NYO" = Not Yet Organized
+}
 }
 
diff --git a/man/get_test_percentile.Rd b/man/get_test_percentile.Rd
@@ -20,6 +20,6 @@ an integer vector
 }
 \description{
 \code{get_test_percentile} looks up a student's national
-percentile rank from \code{\student_status_norms_2011_dense_extended}.
+percentile rank from \code{student_status_norms_2011_dense_extended}.
 }