@lhncbc/ucum-lhc 7.1.2 → 7.1.4

package/LICENSE.md

@@ -23,14 +23,13 @@ If this product includes all or a portion of the UCUM table, UCUM codes, and
 UCUM definitions or is derived from it, it is subject to a license from 
 Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, 
 UCUM codes, UCUM definitions also is subject to this license, a copy of which is 
-available at http://unitsofmeasure.org. The current complete UCUM table, UCUM 
-Specification are available for download at http://unitsofmeasure.org. The UCUM 
+available at https://ucum.org/license. The current complete UCUM table and UCUM 
+Specification are available for download at https://ucum.org. The UCUM 
 table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. 
 and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. 
 
 If UCUM content is included, this software is distributed under the conditions 
-set forth at http://unitsofmeasure.org/trac/wiki/TermsOfUse and the following 
-terms and conditions.
+set forth at https://ucum.org/license and the following terms and conditions.
 
 The following terms and conditions are based on the BSD open-source license.
 

package/README.md

@@ -1,6 +1,6 @@
 # ucum-lhc
 This is the LHC implementation of validation and conversion services based on
-the [Unified Code for Units of Measure](http://unitsofmeasure.org) (UCUM) code
+the [Unified Code for Units of Measure](https://ucum.org) (UCUM) code
 system created by the Regenstrief Institute, Inc.  
 
 See our [overview page](https://ucum.nlm.nih.gov/ucum-lhc) for
@@ -146,9 +146,7 @@ utils object as described above):
 For information on unit string formatting, look at the _Ucum Unit Expression 
 Validation_ section on the [demo page](https://ucum.nlm.nih.gov/ucum-lhc/demo.html).  
 There is a button labeled "Show entry hints".  That will give you a short description 
-of unit strings, and includes a link to the 
-[UCUM Specification](http://unitsofmeasure.org/ucum.html), where you can find 
-the full deal.
+of unit strings, and includes a link to the [UCUM Specification](https://ucum.org/ucum).
 
 #### convertUnitTo(fromUnitCode, fromVal, toUnitCode, options)
 
@@ -183,7 +181,8 @@ using them in actual clinical settings.
    * 'status' the will be: 'succeeded' if the conversion was successfully
       calculated; 'failed' if the conversion could not be made, e.g., if
       the units are not commensurable; or 'error' if an error occurred;
-   * 'toVal' the numeric value indicating the conversion amount, or null
+   * 'toVal' the numeric value indicating the conversion amount (without any
+      rounding for significant digits), or null
       if the conversion failed (e.g., the units are not commensurable);
    * 'msg' is an array of messages, if the string is invalid or an
       error occurred, indicating the problem, or an explanation of a
@@ -359,3 +358,17 @@ If you wish to modify the code, the build process is simply:
     npm run build
 
 If you wish to modify or update either of the source data files (ucum-essence.xml or ucum.csv), see impexp/README.md for instructions on build steps for data changes.
+
+### Testing
+Tests can be run with:
+
+    npm run test
+
+Although package does not directly use the UCUM "Functional Tests"
+(https://ucum.org/docs/functional-tests and
+https://github.com/FHIR/Ucum-java/blob/master/src/test/resources/UcumFunctionalTests.xml),
+we have run those tests using ucum-lhc, and we found that all but two tests pass.
+The two tests that do not pass are checking for rounding of values at the right
+number of signifant digits.  The package does not round to significant digits,
+since if you round too early in a calculation, you can lose accuracy.
+