add-docs

Author: kauedesousa

R/AAA-getDataCM.R

@@ -27,8 +27,7 @@
 #' @examplesIf interactive()
 #' 
 #' # This function only works with an API key
-#' # the API key can be obtained once a free ClimMob account
-#' # is created via https://climmob.net/
+#' # the API key can be obtained from your ClimMob account
 #'  
 #' library("ClimMobTools")
 #' my_key = "d39a3c66-5822-4930-a9d4-50e7da041e77"
@@ -46,7 +45,6 @@
 #'           server = "climmob3",
 #'           pivot.wider = TRUE)
 #' 
-#' @seealso ClimMob website \url{https://climmob.net/}
 #' @importFrom httr accept_json content RETRY
 #' @importFrom jsonlite fromJSON
 #' @export

R/ClimMobTools.R

@@ -12,8 +12,6 @@
 #'  \url{https://agrdatasci.github.io/ClimMobTools/}}
 #' \item{Report bugs: 
 #'  \url{https://github.com/agrdatasci/ClimMobTools/issues}}
-#' \item{ClimMob Platform: 
-#'  \url{https://climmob.net}}
 #' \item{The tricot user guide: 
 #'  \url{https://hdl.handle.net/10568/109942}}
 #' }

R/getProjectProgress.R

@@ -15,8 +15,7 @@
 #'  
 #' @examplesIf interactive()
 #' # This function only works with an API key
-#' # the API key can be obtained once a free ClimMob account
-#' # is created via https://climmob.net/
+#' # the API key can be obtained from your ClimMob account
 #'  
 #' library("ClimMobTools")
 #' my_key = "ff05a174-28d0-4a40-ab5a-35dc486133a6"
@@ -25,9 +24,6 @@
 #'                    project = "gina2024",
 #'                    userowner = "student",
 #'                    server = "1000FARMS")
-#' 
-#' 
-#' @seealso ClimMob website \url{https://climmob.net/}
 #' @export
 getProjectProgress = function(key, project, userowner, server = "climmob3"){
 

R/getProjectsCM.R

@@ -64,14 +64,12 @@
 #' \item{creation_date}{date where the project was created}
 #' @examplesIf interactive()
 #' # This function only works with an API key
-#' # the API key can be obtained once a free ClimMob account
-#' # is created via https://climmob.net/
+#' # the API key can be obtained from your ClimMob account
 #' 
 #' my_key = "ff05a174-28d0-4a40-ab5a-35dc486133a6"
 #' 
 #' getProjectsCM(key = my_key, server = "1000FARMS")
 #' 
-#' @seealso ClimMob website \url{https://climmob.net/}
 #' @export
 getProjectsCM = function(key, server = "climmob3", ...){
 

R/getTraitList.R

@@ -12,7 +12,6 @@
 #' @param ... additional arguments, not implemented yet
 #' @return a list with trait validation data
 #' @examplesIf interactive() 
-#' 
 #' require("gosset")
 #' 
 #' data("breadwheat", package = "gosset")

R/rankTricot.R

@@ -15,11 +15,6 @@
 #' tricot items and the local item
 #' @param ... additional arguments passed to methods. See details
 #' @return a PlackettLuce "rankings" or "grouped_rankings" object 
-#' @references 
-#' 
-#' van Etten J., et al. (2019). Experimental Agriculture, 55(S1), 275–296.
-#' \doi{10.1017/S0014479716000739}
-#' 
 #' @details 
 #' full.output: logical, to return a list with a "rankings", 
 #' a "grouped_rankings" and the ordered items