# Report Tutorial: `entity_filter`

## Purpose

Validates a list of entity names and returns matching entities, including conflict/deactivation flags.

## Report Name

`entity_filter`

## Required Parameters (API)

- `input_data`: `list[str]`

## Examples

API (recommended, because this report requires input list parameters):

```python
df = bf.report.run(
    "entity_filter",
    input_data=["BRCA1", "BRCA2", "TP53", "NOT_A_GENE"],
)
```

CLI:

```bash
biofilter --db-uri sqlite:///biofilter_dev.db report run --report-name entity_filter --input BRCA1 --input BRCA2 --input TP53 --input NOT_A_GENE
```

With input file:

```bash
biofilter --db-uri sqlite:///biofilter_dev.db report run --report-name entity_filter --input-file ./entities.txt
```

## Recommended Demo Columns

- `input_original`
- `primary_name`
- `group_name`
- `has_conflict`
- `is_deactive`
- `observation`
