hecateSearch: Search Hecate concepts and return results as a data frame

View source: R/hecateSearch.R

hecateSearchR Documentation

Search Hecate concepts and return results as a data frame

Description

Search Hecate concepts and return results as a data frame

Usage

hecateSearch(
  query,
  vocabularyId = NULL,
  standardConcept = NULL,
  domainId = NULL,
  conceptClassId = NULL,
  limit = 20,
  client = hecateClient()
)

Arguments

query

Character(1); search query (required).

vocabularyId

Character(1) or NULL; optional vocabulary filter (comma-separated).

standardConcept

Character(1) or NULL; e.g. "S" (Standard), "C" (Classification).

domainId

Character(1) or NULL; optional domain filter (comma-separated).

conceptClassId

Character(1) or NULL; optional concept class filter.

limit

Integer(1); max results (default 20, max 150).

client

Hecate client (default hecateClient()).

Value

Data frame of search results, or NULL if an error occurred (API error or bad response shape).

Examples

## Not run: 
# Simple search
df <- hecateSearch("diabetes")

# Search with filters
df <- hecateSearch("hypertension", domainId = "Condition", limit = 10)

## End(Not run)

PatientGenerator documentation built on Sept. 16, 2026, 1:06 a.m.