tealflow_list_modules
Discover available Teal modules with descriptions and dataset requirements. Filter by package (clinical/general) and category to find suitable analysis modules.
Instructions
List all available Teal modules with their descriptions and dataset requirements.
This tool helps discover what analysis modules are available in the Teal framework. Modules can be filtered by package (clinical vs general) and optionally by category.
Clinical modules are designed for clinical trial reporting and work with ADaM datasets. General modules are for general-purpose data exploration and work with any data.frame.
Args: package (str, optional): Filter by package - 'clinical', 'general', or 'all'. Defaults to 'all'. category (str, optional): Filter by category like 'graphics', 'tables', 'analysis'. Defaults to None. response_format (str, optional): Output format - 'markdown' for human-readable or 'json' for machine-readable. Defaults to 'markdown'.
Returns: str: List of modules with names, descriptions, and required datasets
Dataset requirements may include flexible types:
- BDS_DATASET: Works with any BDS-structured dataset
- BDS_CONTINUOUS: Works with BDS datasets containing continuous data
- BDS_BINARY: Works with BDS datasets containing binary outcomes
- Specific names (ADSL, ADTTE, ADAE): Require exact dataset match
Markdown format:
# Teal Modules (Package Name)
## module_name
**Description**: Module description
**Required Datasets**: ADSL, BDS_CONTINUOUS (or "None")
JSON format:
{
"modules": [
{
"name": "tm_t_ancova",
"description": "ANCOVA Table",
"required_datasets": ["ADSL", "BDS_CONTINUOUS"]
}
],
"count": 10
}Examples: - List all clinical modules: package="clinical" - List graphics modules: category="graphics" - Get machine-readable list: response_format="json"
Note: Use tealflow_get_module_details to see typical datasets and detailed requirements for modules with flexible dataset types.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| package | No | all | |
| category | No | ||
| response_format | No | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |