faers_signal_screen
Screen a drug against all its reported adverse events or an event against all drugs, calculating ROR, PRR, and chi-square disproportionality signals with optional date filters.
Instructions
Screen a drug against all its reported events, or an event against all its drugs.
ROR, PRR and chi-square for every term with named criteria. The database-wide marginals come from a single cached count call rather than one call per term, so a 200-term screen costs ~13 calls cold and ~10 warm. Any date window or raw_filter is applied to every marginal.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Screen a drug against its events, or an event against its drugs. | drug |
| term | Yes | Active substance (mode='drug') or MedDRA PT (mode='event'). | |
| top_n | No | How many terms to screen. | |
| date_to | No | End of a receivedate window, YYYYMMDD. Must be paired with date_from. | |
| sort_by | No | Statistic to sort rows by. | ror_lower |
| return_n | No | How many rows to return. | |
| date_from | No | Start of a receivedate window, YYYYMMDD. Must be paired with date_to. | |
| min_cases | No | Minimum case count for a row to be reported. | |
| raw_filter | No | Extra Lucene clause ANDed onto the preset query, e.g. 'patient.patientsex:2'. Applied to every marginal of a contingency table. See faers_describe_fields. | |
| signals_only | No | Return only rows meeting the EMA ROR criterion. | |
| max_fallback_calls | No | Cap on per-term lookups for terms absent from the cached global marginal table. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||