From 328c2df08aed28195ebbb51a3291a1bc59616d02 Mon Sep 17 00:00:00 2001 From: David LeBauer Date: Tue, 30 Apr 2019 10:55:51 +0200 Subject: [PATCH] documented parameters in as.ba_db --- R/as.ba_db.R | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/R/as.ba_db.R b/R/as.ba_db.R index 49f29ff..6f7cbf7 100644 --- a/R/as.ba_db.R +++ b/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