view release on metacpan or  search on metacpan

script/csv-mix-formulas  view on Meta::CPAN

use Log::ger;

use Perinci::CmdLine::Any;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-02-24'; # DATE
our $DIST = 'App-CSVUtils-csv_mix_formulas'; # DIST
our $VERSION = '0.002'; # VERSION

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/CSVUtils/csv_mix_formulas/csv_mix_formulas",
    program_name => "csv-mix-formulas",
    log => 1,
    read_config => 0,
    read_env => 0,
    use_utf8 => 1,
);

$cmdline->run;

# ABSTRACT: Mix several formulas/recipes (lists of ingredients and their weights/volumes) into one, and output the combined formula
# PODNAME: csv-mix-formulas

__END__

=pod

=encoding UTF-8

=head1 NAME

csv-mix-formulas - Mix several formulas/recipes (lists of ingredients and their weights/volumes) into one, and output the combined formula

=head1 VERSION

This document describes version 0.002 of csv-mix-formulas (from Perl distribution App-CSVUtils-csv_mix_formulas), released on 2024-02-24.

=head1 SYNOPSIS

B<csv-mix-formulas> B<L<--help|/"--help, -h, -?">> (or B<L<-h|/"--help, -h, -?">>, B<L<-?|/"--help, -h, -?">>)

B<csv-mix-formulas> B<L<--version|/"--version, -v">> (or B<L<-v|/"--version, -v">>)

B<csv-mix-formulas> [B<L<--debug|/"--debug">>|B<L<--log-level|/"--log-level=s">>=I<level>|B<L<--quiet|/"--quiet">>|B<L<--trace|/"--trace">>|B<L<--verbose|/"--verbose">>] [B<L<--format|/"--format=s">>=I<name>|B<L<--json|/"--json">>] [B<L<--ingredient-...

=head1 DESCRIPTION

Each formula is a CSV comprised of at least two fields. The first field (by
default literally the first field, but can also be specified using
C<--ingredient-field>) is assumed to contain the name of ingredients. The second
field (by default literally the second field, but can also be specified using
C<--weight-field>) is assumed to contain the weight of ingredients. A percent
form is recognized and will be converted to its decimal form (e.g. "60%" or
"60.0 %" will become 0.6).

Example, mixing this CSV:

 ingredient,%weight,extra-field1,extra-field2
 water,80,foo,bar
 sugar,15,foo,bar
 citric acid,0.3,foo,bar
 strawberry syrup,4.7,foo,bar

and this:

 ingredient,%weight,extra-field1,extra-field2,extra-field3
 lemon syrup,5.75,bar,baz,qux
 citric acid,0.25,bar,baz,qux
 sugar,14,bar,baz,qux
 water,80,bar,baz,qux

will result in the following CSV. Note: 1) for the header, except for the first
two fields which are the ingredient name and weight which will contain the mixed
formula, the other fields will simply collect values from all the CSV files. 2)
for sorting order: decreasing weight then by name.

 ingredient,%weight,extra-field1,extra-field2,extra-field3
 water,80,foo,bar,qux
 sugar,14.5,foor,bar,qux
 lemon syrup,2.875,bar,baz,qux
 strawberry syrup,2.35,foo,bar,
 citric acid,0.275,foo,bar,qux

Keywords: compositions, mixture, combine

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--ingredient-field>=I<s>

Specify field which contain the ingredient names.

=item B<--weight-field>=I<s>

Specify field which contain the weights.

=back

=head2 Formatting options

=over

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

A sprintf() template to format the weight.

=item B<--output-percent>

If enabled, will convert output weights to percent with the percent sign (e.g. 0.6 to "60%").

=item B<--output-percent-nosign>

If enabled, will convert output weights to percent without the percent sign (e.g. 0.6 to "60").

=back

=head2 Input options

=over

=item B<--input-escape-char>=I<s>

Specify character to escape value in field in input CSV, will be passed to Text::CSV_XS.

Defaults to C<\\> (backslash). Overrides C<--input-tsv> option.


=item B<--input-filename>=I<s@>

Input CSV files.

Default value:

 ["-"]

Use C<-> to read from stdin.