@sjcrh/proteinpaint-shared 2.87.0 → 2.88.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sjcrh/proteinpaint-shared",
-  "version": "2.87.0",
+  "version": "2.88.2",
   "description": "ProteinPaint code that is shared between server and client-side workspaces",
   "type": "module",
   "main": "src/index.js",

package/src/descriptive.stats.js

@@ -1,4 +1,4 @@
-import { roundValue } from './roundValue.js'
+import { roundValueAuto } from './roundValue.js'
 
 /* This file generates summary statistics on any given array of numbers*/
 
@@ -42,15 +42,15 @@ export default function summaryStats(array) {
 	return {
 		values: [
 			{ id: 'total', label: 'Total', value: n },
-			{ id: 'min', label: 'Minimum', value: roundValue(min, 2) },
-			{ id: 'p25', label: '1st quartile', value: roundValue(p25, 2) },
-			{ id: 'median', label: 'Median', value: roundValue(median, 2) },
-			{ id: 'mean', label: 'Mean', value: roundValue(mean(arr), 2) },
-			{ id: 'p75', label: '3rd quartile', value: roundValue(p75, 2) },
-			{ id: 'max', label: 'Maximum', value: roundValue(max, 2) },
-			{ id: 'SD', label: 'Standard deviation', value: roundValue(stdDev, 2) },
-			{ id: 'variance', label: 'Variance', value: roundValue(variance, 2) },
-			{ id: 'IQR', label: 'Inter-quartile range', value: roundValue(IQR, 2) }
+			{ id: 'min', label: 'Minimum', value: roundValueAuto(min, true) },
+			{ id: 'p25', label: '1st quartile', value: roundValueAuto(p25, true) },
+			{ id: 'median', label: 'Median', value: roundValueAuto(median, true) },
+			{ id: 'mean', label: 'Mean', value: roundValueAuto(mean(arr), true) },
+			{ id: 'p75', label: '3rd quartile', value: roundValueAuto(p75, true) },
+			{ id: 'max', label: 'Maximum', value: roundValueAuto(max, true) },
+			{ id: 'SD', label: 'Standard deviation', value: roundValueAuto(stdDev, true) },
+			{ id: 'variance', label: 'Variance', value: roundValueAuto(variance, true) },
+			{ id: 'IQR', label: 'Inter-quartile range', value: roundValueAuto(IQR, true) }
 		]
 	}
 }

package/src/roundValue.js

@@ -7,6 +7,7 @@ round a value to specified digits
 value: given value
 digits: number of digits to round to
 */
+
 export function roundValue(value, digits) {
 	const v = Number(value)
 	if (Number.isInteger(v)) return v
@@ -14,10 +15,18 @@ export function roundValue(value, digits) {
 	return Number(v.toFixed(digits))
 }
 
-export function roundValueAuto(value) {
-	const dp = decimalPlacesUntilFirstNonZero(value)
-	let digits = Math.abs(value) > 1 ? 2 : dp > 0 ? dp + 1 : 2
+/** Rounds numbers to the appropriate decimal point
+ * if format is true, returns either a number or string in
+ * scientific notation.
+ *
+ * TODO: Review digit logic.
+ */
 
+export function roundValueAuto(value, format = false) {
+	if (!value && value != 0) return value
+	const dp = decimalPlacesUntilFirstNonZero(value)
+	const digits = Math.abs(value) > 1 ? 2 : dp > 0 ? dp + 1 : 2
+	if (format) return formatValue(value, digits)
 	return roundValue(value, digits)
 }
 
@@ -46,3 +55,39 @@ export function decimalPlacesUntilFirstNonZero(number) {
 
 	return decimalPlaces
 }
+
+/* 
+simple logic to return a number close to original while rounding up decimals.
+supplements roundValueAuto which rounds 12345 to 1.2e4 which is only suitable for human quick glance but not subsequent computing
+
+TODO:
+10000 and 10001 to 1e4
+0.00001 to 1e-5
+1.00001 to 1
+*/
+export function roundValue2(value) {
+	if (!Number.isFinite(value)) return value // not a number
+	if (Number.isInteger(value)) return value // is integer, do not convert
+	const abs = Math.abs(value)
+	if (abs > 100) return Math.round(value) // 12345.1234 to 12345 (compared to 1.2e4 from roundValueAuto)
+	if (abs > 10) return Number(value.toFixed(1)) // 99.1234 to 99.1
+	if (abs > 1) return Number(value.toFixed(2)) // 9.1234 to 9.12
+	if (abs > 0.1) return Number(value.toFixed(3)) // 0.12345 to 0.123
+	if (abs > 0.01) return Number(value.toFixed(4)) // 0.012345 to 0.0123
+	return value // as is
+}
+
+/** Use to return displayed values in scientific notation
+ * Do not use for values intended for calculation later.
+ */
+export function formatValue(value, digits) {
+	const v = Number(value)
+	if (Number.isInteger(v)) return v
+	const abs = Math.abs(v)
+	if (abs < 1 || abs > 9999) {
+		//Number() reverts positive values less than 10^21 to a whole number
+		//To return the value in scientific notation, use toPrecision without Number()
+		return abs > 9999 ? v.toPrecision(digits) : Number(v.toPrecision(digits))
+	}
+	return Number(v.toFixed(digits))
+}