Updated readme

Author: Ladvien

R/MergeCSVs.R

@@ -1,20 +1,23 @@
 #' Merges two HMIS CSV sets.
 #'
-#' @param string path to folder contaning first CSV set.
-#' @param string path to folder contaning second CSV set.
-#' @param string path to output where merged CSVs will be written.
-#' @param boolean save in feather file format.  Default is false.
+#' @param string Path to folder contaning first CSV set.
+#' @param string Path to folder contaning second CSV set.
+#' @param string Path to output where merged CSVs will be written.
+#' @param boolean Save in feather file format.  Default is false. Loading binary data from file takes around 1/10 the time compared to loading a CSV
 #' @export
 #' @examples
 #' 
+#' # Data will be saved in CSV format.
 #' mergeHmisCSVs('/Users/user/local/CSV_2016', 
 #'               '/Users/user/local/CSV_2016',
 #'               '/Users/user/local/CSV_2016_and_2017')
-#' 
+#'
+#' # Data will be saved in binary format.
 #' mergeHmisCSVs('/Users/user/local/CSV_2016', 
 #'               '/Users/user/local/CSV_2016',
 #'               '/Users/user/local/CSV_2016_and_2017'
 #'                feather = TRUE)
+#'
 mergeHmisCSVs <- function(dataPathOne, 
                              dataPathTwo, 
                              pathForCombinedData,

README.md

@@ -7,7 +7,7 @@ These tools are meant to augment any HMIS implementations by creating methods to
 This allows any HMIS implementation to be more loosely coupled to their software provider, since all HMIS software providers are required to produce HMIS CSVs.
 
 ## HMIS Levels
-HMIS data and methods are structured on three levels, System, Agency, and Project.
+HMIS data and methods are structured on three levels: System, Agency, and Project.
 
 ### System
 HUD requires HMIS software vendors implement tools to pull the following standardized reports: