Skip to content
voiage

voiage.cli.plot_coss_command

plot_coss_command

Section titled “plot_coss_command”
plot_coss_command([positional or keyword] result_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to a CossResultV1 JSON contract or calculate-coss JSON output'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save the COSS plot')) -> None

Plot an experimental COSS result using accessible visual encodings.

Parameters:

  • result_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to a CossResultV1 JSON contract or calculate-coss JSON output'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save the COSS plot'))

Returns: None