list_endpoints: List data end points for API

In niaid/tbportals.depot.api: Convenient R Wrapper for TB Portals DEPOT Tidy API

List data end points for API

Description

list_endpoints generates a convenient data.frame listing the endpoint name under "endpoint" along with a high-level general description of the endpoint data under "description"

Usage

list_endpoints()

Details

list_endpoints will list the available endpoints that return data from the Tidy Depot API along with a description of the type of data provided. It is a useful function to ensure that the name provided as part of the "path" argument to tidy_depo_api function call. If the name provided to the path argument is incorrect then an error will be thrown and no API call returned.

Value

data frame of available endpoints

Author(s)

Gabriel Rosenfeld, [e-mail]

niaid/tbportals.depot.api documentation built on Feb. 22, 2025, 5:41 p.m.