The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-MineralUtils-0.006
River stage zero No dependents
/ convert-magnesium-unit

NAME

convert-magnesium-unit - Convert a magnesium quantity from one unit to another

VERSION

This document describes version 0.006 of convert-magnesium-unit (from Perl distribution App-MineralUtils), released on 2021-12-09.

SYNOPSIS

Usage:

% convert-magnesium-unit [--format=name|--json] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] -- [quantity] [to_unit]

DESCRIPTION

If target unit is not specified, will show all known conversions.

OPTIONS

* marks required options.

Main options

--quantity=s

Default value:

 "1 mg"

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

--to-unit=s

Valid values:

 ["mg","mg-mg-elem","mg-mg-citrate","mg-mg-citrate-ah","mg-mg-citrate-ah-nowfoods","mg-mg-glycinate","mg-mg-bisglycinate","mg-mg-bisglycinate-nowfoods","mg-mg-ascorbate","mg-mg-pidolate","mg-mg-l-threonate","mg-mg-oxide","mg-mg-lactate-dihydrate"]

Can also be specified as the 2nd command-line argument.

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 convert-magnesium-unit convert-magnesium-unit

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 convert-magnesium-unit 'p/*/`convert-magnesium-unit`/'

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.

EXAMPLES

Show all possible conversions:

 % convert-magnesium-unit
 +--------+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
 | amount | unit                        | summary                                                                                                               |
 +--------+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
 |  1.000 | mg-mg-elem                  | Elemental magnesium, in milligrams                                                                                    |
 |  8.850 | mg-mg-citrate               | Magnesium citrate (C6H6MgO7), in milligrams                                                                           |
 |  6.289 | mg-mg-citrate-ah            | Magnesium citrate anhydrous (C6H5Mg3O7), in milligrams                                                                |
 |  6.897 | mg-mg-citrate-ah-nowfoods   | Magnesium citrate in NOW Foods supplement (anhydrous, C6H5Mg3O7, 90.9% pure, contains citric acid etc), in milligrams |
 |  7.092 | mg-mg-glycinate             | Magnesium glycinate/bisglycinate (C4H8MgN2O4), in milligrams                                                          |
 |  7.092 | mg-mg-bisglycinate          | Magnesium glycinate/bisglycinate (C4H8MgN2O4), in milligrams                                                          |
 | 10.000 | mg-mg-bisglycinate-nowfoods | Magnesium bisglycinate in NOW Foods supplement (C4H8MgN2O4, 70.5% pure, contains citric acid etc), in milligrams      |
 | 13.514 | mg-mg-ascorbate             | Magnesium ascorbate/pidolate (C11H13MgNO9), in milligrams                                                             |
 | 13.514 | mg-mg-pidolate              | Magnesium ascorbate/pidolate (C11H13MgNO9), in milligrams                                                             |
 | 12.048 | mg-mg-l-threonate           | Magnesium L-threonate (C8H14MgO10), in milligrams                                                                     |
 |  1.658 | mg-mg-oxide                 | Magnesium oxide (MgO), in milligrams                                                                                  |
 |  9.804 | mg-mg-lactate-dihydrate     | Magnesium lactate dihydrate (C6H14MgO8), in milligrams                                                                |
 +--------+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+

Find out how many milligrams of elemental magnesium is in 1000mg of pure magnesium l-threonate (but note that a supplement product might not contain 100%-pure compound):

 % convert-magnesium-unit '1000 mg-mg-l-threonate' mg-mg-elem
 83

Find out how many milligrams of elemental magnesium is in 3g (1 recommended serving) of NOW Foods magnesium citrate powder (magnesium content is as advertised on the label):

 % convert-magnesium-unit '3000 mg-mg-citrate-ah-nowfoods' mg-mg-elem
 435

Find out how many milligrams of elemental magnesium is in 2.5g (1 recommended serving) of NOW Foods magnesium bisglycinate powder (magnesium content is as advertised on the label):

 % convert-magnesium-unit '2500 mg-mg-bisglycinate-nowfoods' mg-mg-elem
 250

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-MineralUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-MineralUtils.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

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

BUGS

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

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.