Skip to content

Commit 7978e57

Browse files
committed
doc: add docstrings for new baseline methods
1 parent 4358f2b commit 7978e57

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

pyAKI/probes.py

+10-5
Original file line numberDiff line numberDiff line change
@@ -178,11 +178,16 @@ class CreatinineBaselineMethod(StrEnum):
178178
The available methods are `MIN` and `FIRST`.
179179
180180
Attributes:
181-
ROLLING_MIN: Represents the minimum method for creatinine calculations. Minimum creatinine value within the specified time window before observation is used as baseline.
182-
ROLLING_FIRST: Represents the first method for creatinine calculations. First creatinine value within the specified time window before observation is used as baseline.
183-
FIXED_FIRST: Represents the fixed method for creatinine calculations. A fixed window (default 7 days) ist used for baseline calculation. Values from the window are used as baseline throughout the observation period.
184-
CONSTAN: Represents the constant method for creatinine calculations. The user should provide a dataframe with the constant baseline values, e.g. from a previous stay or a pre-surgery value.
185-
CALCULATED: Represents the calculated method for creatinine calculations. The user needs to provide additional demographic data of the patient: Gender, Age and Height. A modified version of the Gockcrofft-Gault formula is used to calculate the baseline creatinine value.
181+
ROLLING_MIN: Minimum of a rolling window following the timepoint of observation is used as baseline.
182+
ROLLING_FIRST: First value of a rolling window following the timepoint of observation is used as baseline.
183+
ROLLING_MEAN: Mean of a rolling window following the timepoint of observation is used as baseline.
184+
FIXED_MIN: Minimum of the first n days of observation is used as baseline.
185+
FIXED_MEAN: Mean of the first n days of observation is used as baseline.
186+
OVERALL_FIRST: First observed value is used as baseline.
187+
OVERALL_MEAN: Mean of all observed values is used as baseline.
188+
OVERALL_MIN: Minimum of all observed values is used as baseline.
189+
CONSTANT: A constant value is used as baseline.
190+
CALCULATED: A calculated value is used as baseline, based off of the Cockcroft-Gault-Formula using the Adjusted Body Weight.
186191
"""
187192

188193
ROLLING_MIN = auto()

0 commit comments

Comments
 (0)