added an example

zachmayer · Mar 12, 2015 · 99b79b0 · 99b79b0
1 parent b934303
commit 99b79b0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/R/parseBracket.R b/R/parseBracket.R
@@ -9,6 +9,10 @@
 #' @return a data.table
 #' @importFrom data.table fread setcolorder setkeyv :=
 #' @export
+#' @examples
+#' f <- system.file('kaggle_data/sample_submission.csv', package = "kaggleNCAA", mustWork=TRUE)
+#' dat <- parseBracket(f)
+#' head(dat)
 parseBracket <- function(f){
   dat <- fread(f)
   dat[, id := strsplit(dat$id, '_')]

diff --git a/man/parseBracket.Rd b/man/parseBracket.Rd
@@ -22,4 +22,9 @@ problems
 \note{
 Will only have 1 row per game, where team_1 is the lower id team
 }
+\examples{
+f <- system.file('kaggle_data/sample_submission.csv', package = "kaggleNCAA", mustWork=TRUE)
+dat <- parseBracket(f)
+head(dat)
+}