puremoe (version 1.0.3)

endpoint_info: Get Information About Available Endpoints

Description

This function provides detailed information about the available endpoints in the package, including column descriptions, parameters, rate limits, and usage notes.

Usage

endpoint_info(endpoint = NULL, format = c("list", "json"))

Value

If endpoint is NULL, returns a character vector of available endpoint names. If endpoint is specified, returns a list (or JSON string) with detailed information about that endpoint including description, columns, parameters, rate limits, and notes.

Arguments

endpoint

Character string specifying which endpoint to get information about. If NULL (default), returns a list of all available endpoints.

format

Character string specifying the output format. Either "list" (default) or "json" for JSON-formatted output.

Examples

# \donttest{
if (interactive()) {
  # List all available endpoints
  endpoint_info()
  
  # Get information about a specific endpoint
  endpoint_info("pubmed_abstracts")
  
  # Get information in JSON format
  endpoint_info("icites", format = "json")
}
# }