Merge pull request #24 from mitre/weightcap-kg-docs

Tweaking weight_cap note to specify kg

Author: dchud

R/growth.R

@@ -78,7 +78,7 @@
 #'  pediatric algorithm should not be applied (< adult_cutpoint), and the adult
 #'   algorithm should apply (>= adult_cutpoint). Numbers outside this range will be
 #'   changed to the closest number within the range. Defaults to 20.
-#' @param weight_cap Positive number, describing a weight cap (rounded to the
+#' @param weight_cap Positive number, describing a weight cap in kg (rounded to the
 #' nearest .1, +/- .1) within the adult dataset. If there is no weight cap, set
 #'  to Inf. Defaults to Inf.
 #' @param adult_columns_filename Name of file to save original adult data, with additional output columns to

README.Rmd

@@ -590,9 +590,9 @@ techniques.
   should apply (>= adult_cutpoint). Numbers outside this range will be changed to the
   closest number within the range.
 
-- `weight_cap` - default `Inf`; weight_cap Positive number, describing a weight cap
-  (rounded to the nearest .1, +/- .1) within the adult dataset. If there is no weight
-  cap, set to Inf.
+- `weight_cap` - default `Inf`; weight_cap Positive number, describing a weight
+  cap in kg (rounded to the nearest .1, +/- .1) within the adult dataset. If
+  there is no weight cap, set to Inf.
 
 - `adult_columns_filename` - default `""`; Name of file to save original adult data,
   with additional output columns to as CSV. Defaults to "", for which this data will not

README.md

@@ -624,8 +624,8 @@ later techniques.
     closest number within the range.
 
 -   `weight_cap` - default `Inf`; weight\_cap Positive number,
-    describing a weight cap (rounded to the nearest .1, +/- .1) within
-    the adult dataset. If there is no weight cap, set to Inf.
+    describing a weight cap in kg (rounded to the nearest .1, +/- .1)
+    within the adult dataset. If there is no weight cap, set to Inf.
 
 -   `adult_columns_filename` - default `""`; Name of file to save
     original adult data, with additional output columns to as CSV.