R/get_isa_investigation.R

In aberHRML/metabolighteR: Interface to the 'Metabolights' REST API

#' Get ISA Investigation File
#'
#' Retrieve the ISA Investigation for a specified Metabolights Study
#'
#' @param study_id A character string of a valid MTBLS study id
#' @return the ISA-tab Investigation output
#' @export
#' @examples
#' \dontrun{
#' ISA <- get_isa_investigation('MTBLS375')
#' writeLines(isa_investigation_parse, con = paste0('outpath/ISA.txt'))
#' }

get_isa_investigation <- function(study_id)
{
  isa_investigation <-
    httr::GET(
      paste0(
        getOption('BASE_URL'),
        '/studies/',
        study_id,
        '/investigation'
      ),
      httr::add_headers(user_token = getOption('MTBLS_API_KEY'))
    )


  isa_investigation_parse <-
    isa_investigation %>% httr::content('parsed')

  return(isa_investigation_parse)
}