Improve calcCropCalendar() documentation

AgMIP-GGCMI · Aug 9, 2022 · 1b489c5 · 1b489c5
1 parent c953584
commit 1b489c5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/cropCalendars/R/calcCropCalendars.R b/cropCalendars/R/calcCropCalendars.R
@@ -2,6 +2,14 @@
 #'
 #' @description Wrapper function calling sub-functions to
 #' calculate sowing and harvest dates.
+#' @param lon Longitude (decimal degrees)
+#' @param lat Latitude (decimal degrees)
+#' @param mclimate Monthly climate. A list returned by the calcMonthlyClimate()
+#' function.
+#' @param crop A crop name (chr), among those specified in the croppar_file
+#' @param croppar_file Crop parameter file. If not specified, the default one is
+#' used.
+#' @seealso calcMonthlyClimate
 #'
 calcCropCalendars <- function(lon          = NULL,
                               lat          = NULL,