R/ag_project_entity.R

In AGROFIMS/ragapi: An R-implementation of the Agronomy API standard (AgAPI) used by Agronomy Fieldbook Management System (AGROFIMS) platform

#' @include checkers.R utils.R
#' 
#' Project Entity Class
#' 
#' @description subclass for representing agronomic project entity data. It inherents from AgAPI client class 
#' all the basic parameters and methods.
#'
#' @title AgProjEntity
#'
#' @docType class
#'
#' @format R6 class
#'
#' @field user specifies the user name, defaults to NULL 
#' @field password specifies the password, defaults to NULL
#' @field user specifies the user name, defaults to NULL 
#' @field password specifies the password, defaults to NULL
#' @field authentication specifies the password, defaults to NULL
#' @field token specifies the password, defaults to NULL
#' @field user_agent specifies the password, defaults to NULL
#' @field serverURL specifies the password, defaults to 
#'                  http://research.cip.cgiar.org/agrofims/api/dev/
#' @field version specifies the version, defaults to 0051
# @field endPoint specifies the end point value,   tableName/method.php 
#' @importFrom R6 R6Class
#' 
#' @export
#' 
AgProjEntity <- R6::R6Class(
  
  classname = "AgProjEntity",
  inherit = AgAPIClient,
  
  public = list(
    
    initialize = function(user=NULL, password=NULL, authentication=NULL, token=NULL, user_agent=NULL,
                          serverURL, version){ #, endPoint) {
      super$initialize(user, password, authentication, token,user_agent, serverURL, version)#, endPoint)
    },
    
    ag_get_projentity_studyId = function(studyDbId, format,...){}
  )
)

#' @title  Get all project management entities info from an agronomic study by its agronomical study database ID
#' @description retrieve data from databases with AgAPI standard
#' @field studyDbID character agronomical study id
#' @field format support in three data structures: json, list and data.frames
#' @field ... argument inherents by AgaAPIClient
#' @importFrom R6 R6Class
#' @importFrom httr content
#' @importFrom jsonlite fromJSON
#' @importFrom tibble rownames_to_column
#' @author Omar Benites
#' @export 
#' 
AgProjEntity$set(which = "public", name = "ag_get_projentity_studyId",  function(studyDbId =NULL,
                                                                     format=c("json","list","data.frame"),
                                                                     ...){
  
  format <- match.arg(format)
  
  super$endPoint <- "/proj-entity/getAll?id="
  url  <- paste0(self$serverURL, self$version, super$endPoint) #everything before the URL
  #url  <- paste0(self$serverURL, self$version, self$endPoint) #everything before the URL
  
  headerParams <- character()
  
  queryParams <- list(id = studyDbId) #everythig after the ? in the URL 
  
  res <- self$call_api(
    url = url, 
    method = "GET",
    queryParams = queryParams, #, #TODO
    #headerParams = headerParams, #TODO
    #body = body,
    ...
  )
  cont <- httr::content(res, as = "text", encoding = "UTF-8")
  
  if(format=="json"){
    out <-  cont
  } else if(format=="list"){
    out <- jsonlite::prettify(txt = cont) #jsonlite::fromJSON(cont)
  } else if(format=="data.frame") {
    out <- as_data_frame_agapi(cont)
    #cont <- jsonlite::fromJSON(cont)
    #out <- replace_null(cont,"") %>% as.data.frame(stringsAsFactors=FALSE) %>% tibble::rownames_to_column()
  }
  return(out)
  
},
overwrite = TRUE)   


# # #Example
# # #Experimenta details
# # https://research.cip.cgiar.org/agrofims/api/dev/0135/r/proj-entity/getAll?id=
# expdetail_v0118 <- AgExpProjEntity$new(serverURL = "https://research.cip.cgiar.org/agrofims/api/dev",
#                                     version ="/0118/r", endPoint= "/proj-entity/getAll?id=")
# out_test <- expdetail_v0118$ag_projentity( studyDbId= 6, format="data.frame")
# #