NAME

App::MineralUtils - Utilities related to mineral supplements

VERSION

This document describes version 0.008 of App::MineralUtils (from Perl distribution App-MineralUtils), released on 2022-06-17.

DESCRIPTION

This distributions provides the following command-line utilities:

FUNCTIONS

convert_magnesium_unit

Usage:

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

Convert a magnesium quantity from one unit to another.

Examples:

Show all possible conversions:

convert_magnesium_unit();

Result:

[
  200,
  "OK",
  [
    {
      amount  => 1,
      unit    => "mg-mg-elem",
      summary => "Elemental magnesium, in milligrams",
    },
    {
      amount  => 8.84955752212389,
      unit    => "mg-mg-citrate",
      summary => "Magnesium citrate (C6H6MgO7), in milligrams",
    },
    {
      amount  => 6.28930817610063,
      unit    => "mg-mg-citrate-ah",
      summary => "Magnesium citrate anhydrous (C6H5Mg3O7), in milligrams",
    },
    {
      amount  => 6.89655172413793,
      unit    => "mg-mg-citrate-ah-nowfoods",
      summary => "Magnesium citrate in NOW Foods supplement (anhydrous, C6H5Mg3O7, 90.9% pure, contains citric acid etc), in milligrams",
    },
    {
      amount  => 7.09219858156028,
      unit    => "mg-mg-glycinate",
      summary => "Magnesium glycinate/bisglycinate (C4H8MgN2O4), in milligrams",
    },
    {
      amount  => 7.09219858156028,
      unit    => "mg-mg-bisglycinate",
      summary => "Magnesium glycinate/bisglycinate (C4H8MgN2O4), in milligrams",
    },
    {
      amount  => 10,
      unit    => "mg-mg-bisglycinate-nowfoods",
      summary => "Magnesium bisglycinate in NOW Foods supplement (C4H8MgN2O4, 70.5% pure, contains citric acid etc), in milligrams",
    },
    {
      amount  => 15.3846153846154,
      unit    => "mg-mg-ascorbate",
      summary => "Magnesium ascorbate (C12H14MgO12), in milligrams",
    },
    {
      amount  => 11.4942528735632,
      unit    => "mg-mg-pidolate",
      summary => "Magnesium pidolate (C10H12MgN2O6), in milligrams",
    },
    {
      amount  => 12.0481927710843,
      unit    => "mg-mg-l-threonate",
      summary => "Magnesium L-threonate (C8H14MgO10), in milligrams",
    },
    {
      amount  => 1.65837479270315,
      unit    => "mg-mg-oxide",
      summary => "Magnesium oxide (MgO), in milligrams",
    },
    {
      amount  => 9.80392156862745,
      unit    => "mg-mg-lactate-dihydrate",
      summary => "Magnesium lactate dihydrate (C6H14MgO8), in milligrams",
    },
  ],
  {
    "table.fields"        => ["amount", "unit", "summary"],
    "table.field_aligns"  => ["number", "left", "left"],
    "table.field_formats" => [
                               ["number", { thousands_sep => "", precision => 3 }],
                               undef,
                               undef,
                             ],
  },
]

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(quantity => "1000 mg-mg-l-threonate", to_unit => "mg-mg-elem");
```
Result:
```
[200, "OK", 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(
  quantity => "3000 mg-mg-citrate-ah-nowfoods",
  to_unit  => "mg-mg-elem"
);
```
Result:
```
[200, "OK", 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(
  quantity => "2500 mg-mg-bisglycinate-nowfoods",
  to_unit  => "mg-mg-elem"
);
```
Result:
```
[200, "OK", 250, {}]
```

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

This function is not exported.

Arguments ('*' denotes required arguments):

quantity => str (default: "1 mg")
to_unit => str

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

convert_potassium_unit

Usage:

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

Convert a potassium quantity from one unit to another.

Examples:

Show all possible conversions:

convert_potassium_unit();

Result:

[
  200,
  "OK",
  [
    {
      amount  => 1,
      unit    => "mg-k-elem",
      summary => "Elemental potassium, in milligrams",
    },
    {
      amount  => 1.90839694656489,
      unit    => "mg-k-chloride",
      summary => "Potassium chloride (KCl), in milligrams",
    },
    {
      amount  => 1.90839694656489,
      unit    => "mg-k-cl",
      summary => "Potassium chloride (KCl), in milligrams",
    },
    {
      amount  => 7.8125,
      unit    => "mg-k-citrate",
      summary => "Potassium citrate (K3C6H5O7), in milligrams",
    },
  ],
  {
    "table.field_aligns"  => ["number", "left", "left"],
    "table.field_formats" => [
                               ["number", { thousands_sep => "", precision => 3 }],
                               undef,
                               undef,
                             ],
    "table.fields"        => ["amount", "unit", "summary"],
  },
]

How much of potassium chloride provides 1000 mg of elemental potassium?:

convert_potassium_unit(quantity => "1000 mg-k-elem", to_unit => "mg-k-cl");

Result:

[200, "OK", 1908.39694656489, {}]

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

This function is not exported.

Arguments ('*' denotes required arguments):

quantity => str (default: "1 mg")
to_unit => str

Returns an enveloped result (an array).

Return value: (any)

convert_sodium_unit

Usage:

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

Convert a sodium quantity from one unit to another.

Examples:

Show all possible conversions:

convert_sodium_unit();

Result:

[
  200,
  "OK",
  [
    {
      amount  => 1,
      unit    => "mg-na-elem",
      summary => "Elemental sodium, in milligrams",
    },
    {
      amount  => 2.54452926208651,
      unit    => "mg-na-chloride",
      summary => "Sodium chloride (NaCl), in milligrams",
    },
    {
      amount  => 2.54452926208651,
      unit    => "mg-na-cl",
      summary => "Sodium chloride (NaCl), in milligrams",
    },
    {
      amount  => 11.2359550561798,
      unit    => "mg-na-citrate",
      summary => "Sodium citrate (Na3C6H5O7), in milligrams",
    },
  ],
  {
    "table.field_formats" => [
                               ["number", { thousands_sep => "", precision => 3 }],
                               undef,
                               undef,
                             ],
    "table.field_aligns"  => ["number", "left", "left"],
    "table.fields"        => ["amount", "unit", "summary"],
  },
]

How much of sodium chloride provides 1000 mg of elemental sodium?:

convert_sodium_unit(quantity => "1000 mg-na-elem", to_unit => "mg-na-cl");

Result:

[200, "OK", 2544.52926208651, {}]

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

This function is not exported.

Arguments ('*' denotes required arguments):

quantity => str (default: "1 mg")
to_unit => str

Returns an enveloped result (an array).

Return value: (any)

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

To install App::MineralUtils, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::MineralUtils

CPAN shell

perl -MCPAN -e shell
install App::MineralUtils

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

DESCRIPTION

FUNCTIONS

convert_magnesium_unit

convert_potassium_unit

convert_sodium_unit

HOMEPAGE

SOURCE

SEE ALSO

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions