Cli Plot Tacs

CLI module to plot TACs from a TACs folder created by petpal function write-tacs.

Attributes

_PLOT_EXAMPLES_

Module Contents

petpal.cli.cli_plot_tacs._PLOT_EXAMPLES_ = Multiline-String

Show Value

"""
Examples:
  - Plot a single TAC:
    petpal-plot-tacs --tac-files my_tac.tsv --out-fig-path tac.png
  - Plot two or more TACs:
    petpal-plot-tacs --tac-files my_tac_1.tsv my_tac_2.tsv --out-fig-path tac.png
  - Plot all the TACs in a directory:
    petpal-plot-tacs --tac-dir sub-001/tacs/ --out-fig-path tac.png
  - Plot specific regional TACs in a directory based on region names:
    petpal-plot-tacs --tac-files my_tac.tsv --regions RightPutamen LeftPutamen --out-fig-path tac.png
  - Set x-axis and y-axis units:
    petpal-plot-tacs --tac-files my_tac.tsv --yaxis-units cps --xaxis-units hours --out-fig-path tac.png
  - Plot the linear-linear plot only:
    petpal-plot-tacs --tac-files my_tac.tsv --plot-type linear --out-fig-path tac.png
  - Set the figure title to the participant name:
    petpal-plot-tacs --tac-files my_tac.tsv --fig-title sub-001 --out-fig-path tac.png
"""