add missing param defs for ersst #96

ropensci · Dec 1, 2015 · 984c0ed · 984c0ed
1 parent 5b71ec5
commit 984c0ed
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/R/ersst.R b/R/ersst.R
@@ -5,6 +5,10 @@
 #' the current year is. Required
 #' @param month A month, character or numeric. If single digit (e.g. 8), we
 #' add a zero in front (e.g., 08). Required
+#' @param path (character) A path to store the files, a directory. Default:
+#' \code{~/.rnoaa/ersst}. Required.
+#' @param overwrite (logical) To overwrite the path to store files in or not,
+#' Default: \code{TRUE}
 #' @param ... Curl options passed on to \code{\link[httr]{GET}}. Optional
 #' @return An \code{ncdf4} object for now, may change output later to
 #' perhaps a data.frame. See \pkg{ncdf4} for parsing the output.

diff --git a/man/ersst.Rd b/man/ersst.Rd