gprofiler2 (version 0.2.4)

gprofiler_request: Perform a g:Profiler API request

Description

This function sends an HTTP POST request to the g:Profiler API with the provided payload and handles the response accordingly. It parses the JSON response and returns the result.

Usage

gprofiler_request(url, payload)

Value

A list containing the parsed JSON response from the g:Profiler API.

Arguments

url

The URL to which the request is sent.

payload

The payload to be sent in the request body. It should be a list or JSON string.

Author

Liis Kolberg <[e-mail]>

Details

This function sends an HTTP POST request to the specified URL with the provided payload, expecting a JSON response. It handles potential errors, such as non-200 response codes, and parses the JSON response accordingly. If the response code is not 200, an error is raised along with a descriptive message. If the response contains a JSON object with a "message" field, this message is included in the error message.

Examples

# Example usage:
url <- "https://biit.cs.ut.ee/gprofiler/api/gost/profile"
payload <- list(
  organism = jsonlite::unbox("hsapiens"),
  query = c("ENSG00000139618", "ENSG00000141510"),
  sources = c("GO:BP", "KEGG"),
  user_threshold = jsonlite::unbox(0.05),
  all_results = jsonlite::unbox(TRUE)
)
if (FALSE) result <- gprofiler_request(url, payload)