Reporter
Base class for all PhenEx reporters.
A reporter creates an analysis of a cohort. It receives a cohort, executes the reporting analysis, and returns the results. Results can be exported to various formats.
Subclasses must implement
- execute(cohort): Perform the reporting analysis and return results
Subclasses may implement custom export / formatting methods as appropriate for their output type:
- to_excel(filename): Export to Excel format
- to_csv(filename): Export to CSV format
- to_html(filename): Export to HTML format
- to_markdown(filename): Export to Markdown format
- to_word(filename): Export to Word document format
- get_pretty_display(): Format results for display (returns formatted copy of self.df)
Default implementations for each of these methods are defined if execute() returns self.df as a pandas DataFrame.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
decimal_places
|
int
|
Number of decimal places to round to. Default: 1 |
1
|
pretty_display
|
bool
|
If True, format output for display (rounded decimals, display names, empty strings instead of NaNs). Default: True |
True
|
Source code in phenex/reporting/reporter.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | |
execute(cohort)
Execute the reporter analysis on a cohort.
This is the main entry point for all reporters. Subclasses should:
1. Store the cohort: self.cohort = cohort
2. Perform analysis and store results in self.df (or self.report for Dict-based reporters)
3. Return the primary result (DataFrame or Dict)
Note: self.df should always contain the raw, unformatted data. Use get_pretty_display() to get a formatted version for display or export.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cohort
|
The cohort to analyze |
required |
Returns:
| Type | Description |
|---|---|
Union[DataFrame, Dict[str, Any]]
|
Analysis results: self.df or self.report if not returning a DataFrame. |
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
Must be implemented by subclass |
Source code in phenex/reporting/reporter.py
get_pretty_display()
Return a formatted version of the reporter's results for display.
Default implementation returns a copy of self.df with: - Numeric values rounded to decimal_places - NaN values replaced with empty strings for cleaner display
Subclasses can override this method for custom formatting (e.g., phenotype display names).
Returns:
| Type | Description |
|---|---|
DataFrame
|
pd.DataFrame: Formatted copy of the results |
Raises:
| Type | Description |
|---|---|
AttributeError
|
If self.df is not defined |
Source code in phenex/reporting/reporter.py
to_csv(filename)
Export reporter results to CSV format.
Default implementation exports self.df if it exists. Subclasses can override for custom behavior. If pretty_display=True, formats the DataFrame before export.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
str
|
Path to the output file (relative or absolute, with or without .csv extension) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Full path to the created file |
Raises:
| Type | Description |
|---|---|
AttributeError
|
If self.df is not defined (call execute() first) |
Source code in phenex/reporting/reporter.py
to_excel(filename)
Export reporter results to Excel format.
Default implementation exports self.df if it exists. Subclasses can override for custom behavior. If pretty_display=True, formats the DataFrame before export using get_pretty_display().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
str
|
Path to the output file (relative or absolute, with or without .xlsx extension) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Full path to the created file |
Raises:
| Type | Description |
|---|---|
AttributeError
|
If self.df is not defined (call execute() first) |
ImportError
|
If openpyxl is not installed |
Source code in phenex/reporting/reporter.py
to_html(filename)
Export reporter results to HTML format.
Default implementation exports self.df if it exists. Subclasses can override for custom behavior. If pretty_display=True, formats the DataFrame before export.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
str
|
Path to the output file (relative or absolute, with or without .html extension) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Full path to the created file |
Raises:
| Type | Description |
|---|---|
AttributeError
|
If self.df is not defined (call execute() first) |
Source code in phenex/reporting/reporter.py
to_markdown(filename)
Export reporter results to Markdown format.
Default implementation exports self.df if it exists. Subclasses can override for custom behavior. If pretty_display=True, formats the DataFrame before export.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
str
|
Path to the output file (relative or absolute, with or without .md extension) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Full path to the created file |
Raises:
| Type | Description |
|---|---|
AttributeError
|
If self.df is not defined (call execute() first) |
ImportError
|
If tabulate is not installed (required for df.to_markdown()) |
Source code in phenex/reporting/reporter.py
to_word(filename)
Export reporter results to Microsoft Word format.
Default implementation exports self.df as a simple table if it exists. Subclasses can override for custom formatting (headers, styling, etc). If pretty_display=True, formats the DataFrame before export using get_pretty_display().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
str
|
Path to the output file (relative or absolute, with or without .docx extension) |
required |
Returns:
| Name | Type | Description |
|---|---|---|
str |
str
|
Full path to the created file |
Raises:
| Type | Description |
|---|---|
AttributeError
|
If self.df is not defined (call execute() first) |
ImportError
|
If python-docx is not installed |