#!perl

# Note: This script is a CLI for Riap function /App/GnuplotUtils/xyplot
# and generated automatically using Perinci::CmdLine::Gen version 0.499

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-07-02'; # DATE
our $DIST = 'App-GnuplotUtils'; # DIST
our $VERSION = '0.003'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/GnuplotUtils/xyplot",
    program_name => "xyplot",
    read_config => 0,
    read_env => 0,
);

$cmdline->run;

# ABSTRACT: Plot XY dataset(s) using gnuplot
# PODNAME: xyplot

__END__

=pod

=encoding UTF-8

=head1 NAME

xyplot - Plot XY dataset(s) using gnuplot

=head1 VERSION

This document describes version 0.003 of xyplot (from Perl distribution App-GnuplotUtils), released on 2021-07-02.

=head1 SYNOPSIS

Usage:

 % xyplot [-O] [--chart-title=s] [-d=s] [--dataset-data=s+]
     [--dataset-datas-json=s] [--dataset-file=s+] [--dataset-files-json=s]
     [--dataset-style=s+] [--dataset-styles-json=s] [--dataset-title=s+]
     [--dataset-titles-json=s] [--field-delimiter=s] [--format=name]
     [--json] [--(no)naked-res] [--no-overwrite] [--nooverwrite] [-o=s]
     [--output-file=s] [--overwrite] [--page-result[=program]]
     [--view-result[=program]] -- [dataset_file] ...

=head1 DESCRIPTION

This utility is a wrapper for gnuplot to quickly generate a graph from the
command-line and view it using a browser or an image viewer program. You can
specify the dataset to plot directly from the command-line or specify filename
to read the dataset from.

To plot directly from the command-line:

 % xyplot --dataset-data '1,1, 2,3, 3,5.5, 4,7.9, 6,11.5' ; # whitespaces are optional

To add more datasets, specify more C<--dataset-data> options:

 % xyplot --dataset-data '1,1, 2,3, 3,5.5, 4,7.9, 6,11.5' \
          --dataset-data '1,4,2,4,3,2,4,9,5,3,6,6'

To add a title to your chart and every dataset:

 % xyplot --chart-title "my chart" \
          --dataset-title "foo" --dataset-data '1,1, 2,3, 3,5.5, 4,7.9, 6,11.5' \
          --dataset-title "bar" --dataset-data '1,4,2,4,3,2,4,9,5,3,6,6'

To specify dataset from a file, use C<--dataset-file> option (or specify as
arguments):

 % xyplot --dataset-file ds1.txt --dataset-file ds2.txt
 % xyplot ds1.txt ds2.txt

C<ds1.txt> contains these lines:

 1 1
 2 3
 3 5.5
 4 7.9
 6 11.5

Keywords: xychart, XY chart, XY plot

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--chart-title>=I<s>

=item B<--dataset-data>=I<s@>

Dataset(s).

Can be specified multiple times.

=item B<--dataset-datas-json>=I<s>

Dataset(s) (JSON-encoded).

See C<--dataset-data>.

=item B<--dataset-file>=I<s@>

Dataset(s) from file(s).

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

=item B<--dataset-files-json>=I<s>

Dataset(s) from file(s) (JSON-encoded).

See C<--dataset-file>.

Can also be specified as the 1st command-line argument and onwards.

=item B<--dataset-style>=I<s@>

Dataset plot style(s).

Can be specified multiple times.

=item B<--dataset-styles-json>=I<s>

Dataset plot style(s) (JSON-encoded).

See C<--dataset-style>.

=item B<--dataset-title>=I<s@>

Dataset title(s).

Can be specified multiple times.

=item B<--dataset-titles-json>=I<s>

Dataset title(s) (JSON-encoded).

See C<--dataset-title>.

=item B<--field-delimiter>=I<s>, B<-d>

Supply field delimiter character in dataset file instead of the default whitespace(s) or comma(s).

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:

    [1,2,3]


=item B<--output-file>=I<s>, B<-o>

=item B<--overwrite>, B<-O>

=item B<--page-result>

Filter output through a pager.

=item B<--view-result>

View output using a viewer.

=back

=head2 Other options

=over

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

This script has shell tab completion capability with support for several
shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C xyplot xyplot

in your bash startup (e.g. F<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is recommended, however, that you install modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete xyplot 'p/*/`xyplot`/'

in your tcsh startup (e.g. F<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is also recommended to install L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-GnuplotUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-GnuplotUtils>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-GnuplotUtils>

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2018 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut
