documented parameters in as.ba_db

R/as.ba_db.R

@@ -1,19 +1,19 @@
 #' as.ba_db
 #'
 #' @param secure logical; default: false
-#' @param protocol character
-#' @param db character
+#' @param protocol character. Protocol used for accessing API, typically 'http://' or 'https://'
+#' @param db character. domain name
 #' @param port integer; default: 80
-#' @param apipath character; default: ''
-#' @param multicrop logical; default: false
-#' @param crop character
+#' @param apipath character; default: '' path appended to db where the api is hosted 
+#' @param multicrop logical; default: false. Does this database host more than one crop?
+#' @param crop character. Name of crop(s) hosted
 #' @param user character; default: ''
 #' @param password character; default: ''
 #' @param token character; default: ''
 #' @param granttype character; default: 'password'
 #' @param clientid character; default: 'rbrapi'
-#' @param bms logical; default: false
-#' @param version character; default: 'v1'
+#' @param bms logical; default: false. Does this endpoint follow the BMS implementation of BrAPI?
+#' @param version character; default: 'v1'. Which version(s) of BrAPI are supported?
 #'
 #' @return ba_db class
 #' @author Reinhard Simon, Maikel Verouden