Skip to content

Commit

Permalink
doc: add docstrings for CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
aegis301 committed Oct 30, 2023
1 parent 3efb9fa commit 2f66ef0
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions bin/process_aki_stages.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#! /usr/bin/env python3
"""pyAKI CLI tool"""

import typer

Expand All @@ -17,6 +18,25 @@ def main(
rrt_file: str = "rrt.csv",
demographics_file: str = "demographics.csv",
):
"""
CLI tool to process AKI stages from time series data.
CLI tool to process AKI stages from time series data. The tool expects
the following files to be present in the given path: urineoutput.csv, creatinine.csv, rrt.csv, demographics.csv.
Parameters
----------
path : str
Path to the folder containing the data files.
urineoutput_file : str, optional
Name of the file containing urine output data, by default "urineoutput.csv"
creatinine_file : str, optional
name of the file containing creatinine data, by default "creatinine.csv"
rrt_file : str, optional
Name of the file containing rrt data, by default "rrt.csv"
demographics_file : str, optional
Name of the file containing demographic data of the patient like the patients weight, by default "demographics.csv"
"""
root_dir = Path(path)
datasets = []

Expand Down

0 comments on commit 2f66ef0

Please sign in to comment.