create_scatter_plot - CLI interface

Create a scatter plot for two matrix statistics.

create_scatter_plot [-h] [--config_file CONFIG_FILE] [-t TITLE] [--x_label X_LABEL]
                    [--y_label Y_LABEL] [-s STD_DEV_STYLE]
                    plot_filename matrix_filename x_statistic y_statistic

create_scatter_plot positional arguments

  • plot_filename - File location to write plot image. (default: None)

  • matrix_filename - File location of matrix containing data. (default: None)

  • x_statistic - Column header of the vector to use for the x-axis. (default: None)

  • y_statistic - Column header of the vector to use for the y-axis. (default: None)

create_scatter_plot optional arguments

  • -h, --help - show this help message and exit

  • --config_file CONFIG_FILE - Path to configuration file. (default: None)

  • -t TITLE, --title TITLE - A title for the plot image. (default: None)

  • --x_label X_LABEL - A label for the x-axis. (default: None)

  • --y_label Y_LABEL - A label for the y-axis. (default: None)

  • -s STD_DEV_STYLE, --std_dev_style STD_DEV_STYLE - A dictionary of parameters to style a standard deviation ellipse. Multiple etries will result in multiple ellipses. (default: None)