R/wcGetProjectIDs.R

In jmlondon/wcUtils: Utilities to Access the Wildlife Computers Data Portal API

#' Return a vector of deployment IDs associated with a given Project
#' 
#' \code{wcGetProjectIDs} returns a vector of deployment IDs
#' 
#' This function presumes a custom label,'Project', has been setup for deployments on the Wildife
#' Computers Data Portal. The vector of deployment IDs returned will be a subset that match the
#' project name provided in the function call.
#' 
#' @param xml_content XML content/data returned from wcPOST (with 'action=get_deployments')
#' @param project valid project name (required)
#'   
#' @return returns a vector of deployment IDs
#' @export
wcGetProjectIDs <- function(xml_content,project=NULL) {
  if(class(xml_content) == "response") {
    doc <- xml2::read_xml(httr::content(xml_content, 'raw'))
    doc <- XML::xmlParse(doc)
  } else if(class(xml_content) == "xml_document") {
    doc <- XML::xmlParse(xml_content)
  } else {
    stop('xml_content not a valid response or xml_document')
  }
  if(is.null(project)) {
    stop("Error: you must provide a project name")
  }
  valid_project <- 
    XML::getNodeSet(doc,paste("boolean(//data/deployment/labels/category",
                         "/name[text() = 'Project'])",sep=""))
  if(!valid_project) {
    stop("Error: no 'Project' label found")
  }
  xpath <- paste("//data/deployment/labels/category/",
                 "name[text() = 'Project']/../label[text() = '",
                  project,
                 "']/../../../id",sep="")
  ids <- XML::xpathSApply(doc,xpath,XML::xmlValue)
  return(ids)
}