R/searchIndividuals.R

In GA4GHclient: A Bioconductor package for accessing GA4GH API data servers

#' @title searchIndividuals function
#' @description This function gets individuals matching the search criteria.
#' @details This function requests to \code{/individuals/search}.
#' @param host URL of GA4GH API data server.
#' @param datasetId Id of the dataset to search.
#' @param name Returns Individuals with the given name found by case-sensitive
#' string matching.
#' @param nrows Number of rows of the data frame returned by this function.
#' If not defined, the function will return all entries. If the number of
#' available entries is less than the value of this this parameter, the function
#' will silently return only the available entries.
#' @param responseSize Specifies the number of entries to be returned by the
#' server until reach the number of rows defined in \code{nrows} parameter or
#' until get all available entries. If not defined, the server will return the
#' allowed maximum reponse size. Increasing this the value of this parameter will
#' reduce the number of requests and reducing the time required. The will not
#' respect this parameter if the value if larger than its maximum response size.
#' @return \code{\link{DataFrame}} object. \code{NULL} means no registry found.
#' @references \href{http://ga4gh-schemas.readthedocs.io/en/latest/schemas/bio_metadata_service.proto.html#SearchIndividuals}{Official documentation}.
#' @examples
#' host <- "http://1kgenomes.ga4gh.org/"
#' \dontrun{
#' datasetId <- searchDatasets(host, nrows = 1)$id
#' searchIndividuals(host, datasetId, nrows = 10)
#' }
#' @seealso \code{\link{DataFrame}}, \code{\link{getIndividual}}
#' @export searchIndividuals
searchIndividuals <- function(host, datasetId, name = NA_character_,
    nrows = Inf, responseSize = NA_integer_)
{
    request <- unbox(data.frame(datasetId, name, pageSize = responseSize))
    response <- request.post(host, "individuals/search", request)
    while (!is.null(response$nextPageToken) && nrow(response$individuals) < nrows) {
        request$pageToken <- response$nextPageToken
        tmp <- request.post(host, "individuals/search", request)
        response$individuals <- bind_rows(response$individuals, tmp$individuals)
        response$nextPageToken <- tmp$nextPageToken
    }
    if (length(response$individuals) == 0)
        return(NULL)

    if (nrow(response$individuals) > nrows)
        response$individuals <- response$individuals[seq(1, nrows), ]

    is.na(response$individuals) <- response$individuals == "NULL"
    DataFrame(response$individuals)
}