Generate a single API endpoint JSON string — generate_api_endpoint • coMMpass

Wraps a data frame in standard API envelope with metadata and serializes to JSON. Used by [plan_api] targets to produce static JSON files.

Usage

generate_api_endpoint(data, dataset_name, description)

Arguments

data: A data frame to serialize, or NULL if data is unavailable
dataset_name: Short name for this dataset (e.g. "clinical")
description: Human-readable description

Value

A JSON string (character scalar) with `metadata` and `data` fields

See also

Other api: api_get_clinical(), api_get_de_results(), api_get_pathways(), api_get_survival(), api_list_datasets(), api_serve(), generate_api_index()

Examples

if (FALSE) { # \dontrun{
df <- data.frame(a = 1:3, b = letters[1:3])
json <- generate_api_endpoint(df, "example", "Example data")
cat(json)
} # }