NAME

add-who-growth-reference-fields-to-table - Add WHO reference fields to table

VERSION

This document describes version 0.001 of add-who-growth-reference-fields-to-table (from Perl distribution WHO-GrowthReference-GenTable), released on 2021-01-10.

SYNOPSIS

Usage:

 % add-who-growth-reference-fields-to-table [--debug] [--format=name]
     [--json] [--log-level=level] [--(no)naked-res] [--name=s]
     [--page-result[=program]] [--quiet] [--trace] [--verbose]
     [--view-result[=program]] <gender> <dob> <table>

DESCRIPTION

You supply a CSV/TSV containing these fields: date (or age), height, and weight. And these additional fields will be added:

 height_potential
 height_zscore
 height_z-3
 height_z-2
 height_z-1
 height_z0
 height_z+1
 height_z+2
 height_z+3
 weight_zscore
 weight_z-3
 weight_z-2
 weight_z-1
 weight_z0
 weight_z+1
 weight_z+2
 weight_z+3
 bmi_zscore
 bmi_z-2
 bmi_z-1
 bmi_z0
 bmi_z+1
 bmi_z+2

OPTIONS

* marks required options.

Main options

--dob=s*

--gender=s*

Valid values:

 ["M","F"]

--name=s

--table=s*

Table of growth, must be in CSV/TSV format, containing at least age/date and weight/height columns.

TSV/CSV must have header line.

Date must be string in YYYY-MM-DD format. Age must be float in years. Weight must be float in kg. Height must be float in cm.

Example:

    date,height,weight
    2020-11-01,113.5,17.8
    2020-11-15,113.5,17.9
    2020-12-01,114,17.9
    2020-12-15,114,17.9
    2021-01-01,115,18.1
    2021-01-15,115.5,18.3
    2021-02-01,116,18.4

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

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

Default value:

 undef

--json

Set output format to json.

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

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

 complete -C add-who-growth-reference-fields-to-table add-who-growth-reference-fields-to-table

in your bash startup (e.g. ~/.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 cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete add-who-growth-reference-fields-to-table 'p/*/`add-who-growth-reference-fields-to-table`/'

in your tcsh startup (e.g. ~/.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 shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/WHO-GrowthReference-GenTable.

SOURCE

Source repository is at https://github.com/perlancar/perl-WHO-GrowthReference-GenTable.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=WHO-GrowthReference-GenTable

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 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.

cpanm WHO::GrowthReference::GenTable

perl -MCPAN -e shell
install WHO::GrowthReference::GenTable