LINREGPLOT

Section: User Commands (1)
Updated: July 2012
Index Return to Main Contents

NAME

linregplot - Linear Regression (OLS) and plot

SYNOPSIS

This reads in a data-file containing one or more columns of int/float data.
Calculates the linear regression parameters, and plots the data and its best-fit line.

DESCRIPTION

linregplot:  plot a data-file, and its simple-linear-regression best-fit. Show summary information.

USAGE:    linregplot.py  [OPTS]  infile.dat

OPTIONS:  -f, --samplefreq  FREQ        define the sampling frequency in Hz. [default: 1.0].
           -c, --column      n,sum,all   use Nth column's data (N is 0-based). [default: all].

           -t, --title       TITLE       override plot title
           -x, --xlabel      LABEL       override x-axis label
           -y, --xlabel      LABEL       override y-axis label
           -u, --ulabel      L,A,BE,LS   override legend labels

           -s, --separate                plot raw and regession graphs separately. [default: same axes].
           -o, --outplot     FILE.png    save main plot as FILE.png/.jpg, "auto" names it after infile.

           -n, --noplot                  don't draw the plot window on screen (useful for testing/scripting).
           -h, --help                    show help

INPUT:    Input file, infile.dat ('-' for stdin) should be columns of (int/float) data, separated by
           whitespace, with optional #comments, i.e. the standard form for numpy.loadfile(). cf. genffttest.
           (compressed files (.gz/.bz2) can also be read transparently, no need to uncompress first.)

NOTE 1:   Read this source for an explanation of the simple least-squares linear-regression maths.

NOTE 2:   Error-bars (in grey) are only shown for single-column plots, i.e. except when "-c all".

AUTHOR

The author of linregplot and this manual page is Richard Neill, <maths#AT(spamblock)#richardneill.org>
Copyright July 2012; this is Free Software (GPL v3+), see the source for copying conditions.