Skip to content

Commit

Permalink
update args and doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexPatrie committed Aug 1, 2024
1 parent c763dec commit 1807842
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions bio_check/verifier.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ def visualize(
output_end: int,
num_points: int,
hue: str = 'simulators',
use_grid=False,
export_plot=False
use_grid: bool = False,
save_dest: Optional[str] = None
) -> Figure:
"""Visualize simulation output data, not comparison data, with subplots for each species.
Expand All @@ -202,7 +202,8 @@ def visualize(
If `'simulators'` is passed, each column will be of its own color. If `'species'` is passed, each row will be of its
own color.
use_grid (bool): whether to use a grid for each subplot. Defaults to False.
export_plot (bool): whether to export plots to a pdf file. Defaults to False.
save_dest (str, optional): path to save the figure. If a value is passed here, the figure will be saved to this destination as a .pdf file.
Defaults to `None`.
"""
# grid plot params
Expand Down

0 comments on commit 1807842

Please sign in to comment.