usageinfo-gnuplot

Convert time-dependent tabular 2D data to executable gnuplot scripts.

Synopsis

$ usageinfo [OPTION]... INFILE

Options

• --man

  Prints the manual page and exits.

• --help

  Prints a brief help message and exits.

Reading data

Customize how data is read in.

• --sep=value

  Sets separation character for plain text files.

• --sheet=value

  Sets sheet number for spreadsheet files (default: 1).

• --column=abscol,ordcol

  Sets numbers of abcissa column (default: 1) and ordinate column (default: 2) separated by a comma.

• --dtfmt=datespec

  Sets date specifier accordint to strftime.

Writing data

Customize how data is output.

• -o, --out=filename

  Writes output to specified output file instead of STDOUT.

• -t, --title=string

  Uses specific Gnuplot title.

• --ylabel=value

  Uses specific Gnuplot label for ordinate axis (default: undef).

• --xformat=value

  Uses specific Gnuplot label for ordinate tics (default: undef).

• --yformat=value

  Uses specific Gnuplot label for ordinate tics (default: undef).

• --yrange=value

  Uses specific Gnuplot range for ordinate axis (default: undef).

• -c, --color=colorspec

  Uses specific Gnuplot color.

• -r, --rate=ratespec

  Show first derivative of ordinate values with respect to ratespec. Available options are: year, month, week, day, hour, min, sec. Alternatively, a custom period can be specified in seconds.

• -s, --scale=num

  Scales ordinate values by factor num (default: 1).

• --term=value

  Uses sepecific Gnuplot terminal and option (default: undef).

• -g, --gnuplot=[command]

  Runs gnuplot on output and raises X window. Sets terminal to qt. Submitting the command is optional. If no command is defined, the system will try to auto-detect the location of gnuplot.

Splitting data

Customize how data is split.

• -p, --period=string

  Splits data with respect to periods into datasets. Avaliable options are year, month, week, day, hour (default: year).

• -m, --max=num

  Limits output to latest num datasets. Set to zero to include all available datasets (default: 0).

• --reset

  Resets ordinate values to zero at the start of each dataset.

Requirements

• Math::Derivative - Numeric 1st and 2nd order differentiation
• Math::Spline - Cubic Spline Interpolation of data
• Spreadsheet::Read::Simple - Simple parsing of spreadsheets
• Time::Piece - Object Oriented time objects
• Time::Seconds - API to convert seconds to other data values

Installation

Clone the remote repository and change into the local repository:

$ git clone https://github.com/mboljen/usageinfo-gnuplot
$ cd usageinfo-gnuplot

Use the following command to install this software:

$ make
$ make install

The default PREFIX is set to /usr/local. In order to successfully complete the installation, you need to have write permissions for the installation location.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT