view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::CSVUtils::csv_mix_formulas - Mix several formulas/recipes (lists of
    ingredients and their weights/volumes) into one, and output the combined
    formula

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

FUNCTIONS
  csv_mix_formulas
    Usage:

     csv_mix_formulas(%args) -> [$status_code, $reason, $payload, \%result_meta]

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

    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
    "--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 "--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

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   ingredient_field => *str*

        Specify field which contain the ingredient names.

    *   inplace => *true*

        Output to the same file as input.

        Normally, you output to a different file than input. If you try to
        output to the same file ("-o INPUT.csv -O") you will clobber the
        input file; thus the utility prevents you from doing it. However,
        with this "--inplace" option, you can output to the same file. Like
        perl's "-i" option, this will first output to a temporary file in
        the same directory as the input file then rename to the final file
        at the end. You cannot specify output file ("-o") when using this
        option, but you can specify backup extension with "-b" option.

        Some caveats:

        *   if input file is a symbolic link, it will be replaced with a
            regular file;

        *   renaming (implemented using rename()) can fail if input filename
            is too long;

        *   value specified in "-b" is currently not checked for acceptable
            characters;

        *   things can also fail if permissions are restrictive;

    *   inplace_backup_ext => *str* (default: "")

        Extension to add for backup of input file.

        In inplace mode ("--inplace"), if this option is set to a non-empty
        string, will rename the input file using this extension as a backup.
        The old existing backup will be overwritten, if any.

    *   input_escape_char => *str*

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

        Defaults to "\\" (backslash). Overrides "--input-tsv" option.

    *   input_filenames => *array[filename]* (default: ["-"])

        Input CSV files.

        Use "-" to read from stdin.

        Encoding of input file is assumed to be UTF-8.