Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unit conversion helper #1704

Merged
merged 26 commits into from
Jun 14, 2024
Merged

Unit conversion helper #1704

merged 26 commits into from
Jun 14, 2024

Conversation

rich-iannone
Copy link
Member

This PR adds the unit_conversion() helper function; this returns a conversion factor for transforming a value from one form of measurement units to a target form. For example if you have a length value that is expressed in miles you could transform that value to one in kilometers through multiplication of the value by the conversion factor (in this case 1.60934).

This is useful for expressing values in different units and the conversion can be easily performed via the scale_by argument available in several formatting functions.

When calling unit_conversion(), one must supply two string-based keywords to specify the value's current units and the desired units. All of these keywords are provided in the table shown by calling info_unit_conversions() (which is added here).

@rich-iannone rich-iannone merged commit b2fd5f2 into master Jun 14, 2024
12 checks passed
@rich-iannone rich-iannone deleted the unit-conversion-helper branch June 14, 2024 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant