get_aggregate_records_by_medium: Get aggregate records by medium

In ctxR: Utilities for Interacting with the 'CTX' APIs

Get aggregate records by medium

Description

Get aggregate records by medium

Usage

get_aggregate_records_by_medium(
  Medium = NULL,
  API_key = NULL,
  Server = "https://comptox.epa.gov/ctx-api/exposure",
  pageNumber = 1,
  verbose = FALSE
)

Arguments

Medium	The mmdb medium of exposure.
API_key	The user-specific API key
Server	The root address for the API endpoint
pageNumber	Parameter for how to return data records.
verbose	A logical indicating if some "progress report" should be given.

Value

A list of search parameters and data of aggregate record data by medium.

Examples

#Pull aggregate records for BPA by medium
bpa_agg_records <- get_aggregate_records_by_medium(Medium = 'surface water')

ctxR documentation built on Nov. 5, 2025, 5:08 p.m.