use named variables to increase code clarity

src/components/controls/search.js

@@ -3,6 +3,7 @@ import { connect } from "react-redux";
 import Awesomplete from 'awesomplete'; /* https://leaverou.github.io/awesomplete/ */
 import { updateVisibleTipsAndBranchThicknesses, updateTipRadii } from "../../actions/tree";
 import { dataFont, darkGrey } from "../../globalStyles";
+import { NODE_VISIBLE } from "../../util/globals";
 import { SelectLabel } from "../framework/select-label";
 import "../../css/awesomplete.css";
 
@@ -81,7 +82,7 @@ class SearchStrains extends React.Component {
     /* this tells the serch box which strains are visible
     and therefore are eligible to be searched */
     this.state.awesomplete.list = this.props.nodes
-      .filter((n) => !n.hasChildren && this.props.visibility[n.arrayIdx] === 2)
+      .filter((n) => !n.hasChildren && this.props.visibility[n.arrayIdx] === NODE_VISIBLE)
       .map((n) => n.strain);
     this.state.awesomplete.evaluate();
   }

src/components/info/info.js

@@ -4,7 +4,7 @@ import Card from "../framework/card";
 import { titleFont, headerFont, medGrey, darkGrey } from "../../globalStyles";
 import { applyFilter, changeDateFilter, updateVisibleTipsAndBranchThicknesses } from "../../actions/tree";
 import { prettyString } from "../../util/stringHelpers";
-import { months } from "../../util/globals";
+import { months, NODE_VISIBLE } from "../../util/globals";
 import { displayFilterValueAsButton } from "../framework/footer";
 
 const plurals = {
@@ -32,7 +32,7 @@ const styliseDateRange = (dateStr) => {
 const getNumSelectedTips = (nodes, visibility) => {
   let count = 0;
   nodes.forEach((d, idx) => {
-    if (!d.hasChildren && visibility[idx] === 2) count += 1;
+    if (!d.hasChildren && visibility[idx] === NODE_VISIBLE) count += 1;
   });
   return count;
 };

src/components/map/mapHelpersLatLong.js

@@ -4,6 +4,8 @@ import _minBy from "lodash/minBy";
 import { interpolateNumber } from "d3-interpolate";
 import { averageColors } from "../../util/colorHelpers";
 import { computeMidpoint, Bezier } from "./transmissionBezier";
+import { NODE_NOT_VISIBLE } from "../../util/globals";
+
 
 /* global L */
 // L is global in scope and placed by leaflet()
@@ -61,7 +63,7 @@ const setupDemeData = (nodes, visibility, geoResolution, nodeColors, triplicate,
   // second pass to fill vectors
   nodes.forEach((n, i) => {
     /* demes only count terminal nodes */
-    if (!n.children && visibility[i] !== 0) {
+    if (!n.children && visibility[i] !== NODE_NOT_VISIBLE) {
       // if tip and visible, push
       if (n.attr[geoResolution]) { // check for undefined
         demeMap[n.attr[geoResolution]].push(nodeColors[i]);
@@ -202,7 +204,7 @@ const maybeConstructTransmissionEvent = (
       originNumDate: node.attr["num_date"],
       destinationNumDate: child.attr["num_date"],
       color: nodeColors[node.arrayIdx],
-      visible: visibility[child.arrayIdx] !== 0 ? "visible" : "hidden" // transmission visible if child is visible
+      visible: visibility[child.arrayIdx] !== NODE_NOT_VISIBLE ? "visible" : "hidden" // transmission visible if child is visible
     };
   }
   return transmission;
@@ -370,7 +372,7 @@ const updateDemeDataColAndVis = (demeData, demeIndices, nodes, visibility, geoRe
   // second pass to fill vectors
   nodes.forEach((n, i) => {
     /* demes only count terminal nodes */
-    if (!n.children && visibility[i] !== 0) {
+    if (!n.children && visibility[i] !== NODE_NOT_VISIBLE) {
       // if tip and visible, push
       if (n.attr[geoResolution]) { // check for undefined
         demeMap[n.attr[geoResolution]].push(nodeColors[i]);
@@ -403,7 +405,7 @@ const updateTransmissionDataColAndVis = (transmissionData, transmissionIndices,
           // this is a transmission event from n to child
           const id = node.arrayIdx.toString() + "-" + child.arrayIdx.toString();
           const col = nodeColors[node.arrayIdx];
-          const vis = visibility[child.arrayIdx] !== 0 ? "visible" : "hidden"; // transmission visible if child is visible
+          const vis = visibility[child.arrayIdx] !== NODE_NOT_VISIBLE ? "visible" : "hidden"; // transmission visible if child is visible
 
           // update transmissionData via index lookup
           try {

src/components/tree/phyloTree/change.js

@@ -2,6 +2,7 @@ import { timerFlush } from "d3-timer";
 import { calcConfidenceWidth } from "./confidence";
 import { applyToChildren } from "./helpers";
 import { timerStart, timerEnd } from "../../../util/perf";
+import { NODE_VISIBLE } from "../../../util/globals";
 
 /* loop through the nodes and update each provided prop with the new value
  * additionally, set d.update -> whether or not the node props changed
@@ -48,7 +49,7 @@ const svgSetters = {
     ".tip": {
       fill: (d) => d.fill,
       stroke: (d) => d.tipStroke,
-      visibility: (d) => d.visibility === 2 ? "visible" : "hidden"
+      visibility: (d) => d.visibility === NODE_VISIBLE ? "visible" : "hidden"
     },
     ".conf": {
       stroke: (d) => d.branchStroke,
@@ -57,7 +58,7 @@ const svgSetters = {
     ".branch": {
       stroke: (d) => d.branchStroke,
       "stroke-width": (d) => d["stroke-width"] + "px", // style - as per drawBranches()
-      cursor: (d) => d.visibility === 2 ? "pointer" : "default"
+      cursor: (d) => d.visibility === NODE_VISIBLE ? "pointer" : "default"
     }
   }
 };

src/components/tree/phyloTree/renderers.js

@@ -1,4 +1,5 @@
 import { timerStart, timerEnd } from "../../../util/perf";
+import { NODE_VISIBLE } from "../../../util/globals";
 
 /**
  * @param {d3 selection} svg      -- the svg into which the tree is drawn
@@ -7,7 +8,7 @@ import { timerStart, timerEnd } from "../../../util/perf";
  * @param {object} parameters     -- an object that contains options that will be added to this.params
  * @param {object} callbacks      -- an object with call back function defining mouse behavior
  * @param {array} branchThickness -- array of branch thicknesses (same ordering as tree nodes)
- * @param {array} visibility      -- array of valies in {0, 1, 2} (same ordering as tree nodes)
+ * @param {array} visibility      -- array of visibility of nodes(same ordering as tree nodes)
  * @param {bool} drawConfidence   -- should confidence intervals be drawn?
  * @param {bool} vaccines         -- should vaccine crosses (and dotted lines if applicable) be drawn?
  * @param {array} branchStroke    -- branch stroke colour for each node (set onto each node)
@@ -110,7 +111,7 @@ export const drawTips = function drawTips() {
         .on("mouseout", this.callbacks.onTipLeave)
         .on("click", this.callbacks.onTipClick)
         .style("pointer-events", "auto")
-        .style("visibility", (d) => d.visibility === 2 ? "visible" : "hidden")
+        .style("visibility", (d) => d.visibility === NODE_VISIBLE ? "visible" : "hidden")
         .style("fill", (d) => d.fill || params.tipFill)
         .style("stroke", (d) => d.tipStroke || params.tipStroke)
         .style("stroke-width", () => params.tipStrokeWidth) /* don't want branch thicknesses applied */
@@ -166,7 +167,7 @@ export const drawBranches = function drawBranches() {
         .style("stroke-linecap", "round")
         .style("stroke-width", (d) => d['stroke-width']+"px" || params.branchStrokeWidth)
         .style("fill", "none")
-        .style("cursor", (d) => d.visibility === 2 ? "pointer" : "default")
+        .style("cursor", (d) => d.visibility === NODE_VISIBLE ? "pointer" : "default")
         .style("pointer-events", "auto")
         .on("mouseover", this.callbacks.onBranchHover)
         .on("mouseout", this.callbacks.onBranchLeave)

src/components/tree/reactD3Interface/callbacks.js

@@ -2,11 +2,12 @@ import { rgb } from "d3-color";
 import { interpolateRgb } from "d3-interpolate";
 import { updateVisibleTipsAndBranchThicknesses} from "../../../actions/tree";
 import { branchOpacityFunction } from "../../../util/colorHelpers";
+import { NODE_VISIBLE } from "../../../util/globals";
 
 /* Callbacks used by the tips / branches when hovered / selected */
 
 export const onTipHover = function onTipHover(d) {
-  if (d.visibility !== 2) return;
+  if (d.visibility !== NODE_VISIBLE) return;
   const phylotree = d.that.params.orientation[0] === 1 ?
     this.state.tree :
     this.state.treeToo;
@@ -18,7 +19,7 @@ export const onTipHover = function onTipHover(d) {
 };
 
 export const onTipClick = function onTipClick(d) {
-  if (d.visibility !== 2) return;
+  if (d.visibility !== NODE_VISIBLE) return;
   if (this.props.narrativeMode) return;
   // console.log("tip click", d)
   this.setState({
@@ -34,7 +35,7 @@ export const onTipClick = function onTipClick(d) {
 
 
 export const onBranchHover = function onBranchHover(d) {
-  if (d.visibility !== 2) return;
+  if (d.visibility !== NODE_VISIBLE) return;
   /* emphasize the color of the branch */
   for (const id of ["#branch_S_" + d.n.clade, "#branch_T_" + d.n.clade]) {
     if (this.props.colorByConfidence) {
@@ -67,7 +68,7 @@ export const onBranchHover = function onBranchHover(d) {
 };
 
 export const onBranchClick = function onBranchClick(d) {
-  if (d.visibility !== 2) return;
+  if (d.visibility !== NODE_VISIBLE) return;
   if (this.props.narrativeMode) return;
   const root = [undefined, undefined];
   if (d.that.params.orientation[0] === 1) root[0] = d.n.arrayIdx;

src/util/entropy.js

@@ -1,4 +1,4 @@
-import { genotypeColors } from "./globals";
+import { genotypeColors, NODE_VISIBLE } from "./globals";
 
 const intersectGenes = function intersectGenes(geneMap, pos) {
   for (const gene of Object.keys(geneMap)) {
@@ -15,7 +15,7 @@ const calcMutationCounts = (nodes, visibility, geneMap, isAA) => {
     Object.keys(geneMap).forEach((n) => {sparse[n] = {};});
   }
   nodes.forEach((n) => {
-    if (visibility[n.arrayIdx] !== 2) {return;}
+    if (visibility[n.arrayIdx] !== NODE_VISIBLE) {return;}
     if (isAA) {
       if (n.aa_muts) {
         for (const prot in n.aa_muts) { // eslint-disable-line
@@ -126,7 +126,7 @@ const calcEntropy = (nodes, visibility, geneMap, isAA) => {
         });
         recurse(child, newState);
       }
-    } else if (visibility[node.arrayIdx] === 2) {
+    } else if (visibility[node.arrayIdx] === NODE_VISIBLE) {
       visibleTips++;
       for (const prot of arrayOfProts) {
         for (const pos of Object.keys(state[prot])) {
@@ -193,7 +193,7 @@ const calcEntropy = (nodes, visibility, geneMap, isAA) => {
 /**
 * traverse the tree and compile the entropy data for the visibile branches
 * @param {Array} nodes - list of nodes
-* @param {Array} visibility - 1-1 correspondence with nodes. values: {0, 1, 2}
+* @param {Array} visibility - 1-1 correspondence with nodes.
 * @param {String} mutType - amino acid | nucleotide mutations - "aa" | "nuc"
 * @param {obj} geneMap used to NT fill colours. This should be imroved.
 * @param {bool} showCounts show counts or entropy values?

src/util/globals.js

@@ -174,3 +174,7 @@ export const months = {
 
 export const normalNavBarHeight = 50;
 export const narrativeNavBarHeight = 55;
+
+export const NODE_NOT_VISIBLE = 0;
+export const NODE_VISIBLE_TO_MAP_ONLY = 1;
+export const NODE_VISIBLE = 2;

src/util/processFrequencies.js

@@ -1,3 +1,4 @@
+import { NODE_VISIBLE } from "./globals";
 
 export const unassigned_label = "unassigned";
 
@@ -42,7 +43,7 @@ export const computeMatrixFromRawData = (data, pivots, nodes, visibility, colorS
   // let debugTipsSeen = 0;
   const debugPivotTotals = new Array(pivotsLen).fill(0);
   data.forEach((d) => {
-    if (visibility[d.idx] === 2) {
+    if (visibility[d.idx] === NODE_VISIBLE) {
       // debugTipsSeen++;
       // const colour = tree.nodes[d.idx].attr[colorBy];
       const category = assignCategory(colorScale, categories, nodes[d.idx], colorBy, isGenotype) || unassigned_label;

src/util/treeCountingHelpers.js

@@ -1,3 +1,5 @@
+import { NODE_VISIBLE } from "./globals";
+
 /**
 * traverse the tree to get state counts for supplied traits
 * @param {Array} nodes - list of nodes
@@ -22,7 +24,7 @@ export const countTraitsAcrossTree = (nodes, traits, visibility, terminalOnly) =
         return;
       }
 
-      if (visibility && visibility[node.arrayIdx] !== 2) {
+      if (visibility && visibility[node.arrayIdx] !== NODE_VISIBLE) {
         return;
       }
 
@@ -45,6 +47,6 @@ export const calcTipCounts = (node, visibility) => {
       node.tipCount += node.children[i].tipCount;
     }
   } else {
-    node.tipCount = visibility[node.arrayIdx] === 2 ? 1 : 0;
+    node.tipCount = visibility[node.arrayIdx] === NODE_VISIBLE ? 1 : 0;
   }
 };

src/util/treeTangleHelpers.js

@@ -1,3 +1,4 @@
+import { NODE_VISIBLE } from "./globals";
 
 export const constructVisibleTipLookupBetweenTrees = (nodesLeft, nodesRight, visibilityLeft, visibilityRight) => {
   const tree2StrainToIdxMap = {};
@@ -13,8 +14,8 @@ export const constructVisibleTipLookupBetweenTrees = (nodesLeft, nodesRight, vis
     if (
       !nodesLeft[i].hasChildren &&
       rightIdx &&
-      visibilityLeft[i] === 2 &&
-      visibilityRight[rightIdx] === 2
+      visibilityLeft[i] === NODE_VISIBLE &&
+      visibilityRight[rightIdx] === NODE_VISIBLE
     ) {
       lookup.push([i, tree2StrainToIdxMap[nodesLeft[i].strain]]);
     }

src/util/treeVisibilityHelpers.js

@@ -1,4 +1,4 @@
-import { freqScale } from "./globals";
+import { freqScale, NODE_NOT_VISIBLE, NODE_VISIBLE_TO_MAP_ONLY, NODE_VISIBLE } from "./globals";
 import { calcTipCounts } from "./treeCountingHelpers";
 
 export const strainNameToIdx = (nodes, name) => {
@@ -125,22 +125,21 @@ const calcVisibility = (tree, controls, dates) => {
         const nodeDate = node.attr.num_date;
         /* is the actual node date (the "end" of the branch) in the time slice? */
         if (nodeDate >= dates.dateMinNumeric && nodeDate <= dates.dateMaxNumeric) {
-          return 2;
+          return NODE_VISIBLE;
         }
         /* is any part of the (parent date -> node date) in the time slice? */
         if (!(nodeDate < dates.dateMinNumeric || node.parent.attr.num_date > dates.dateMaxNumeric)) {
-          return 1;
+          return NODE_VISIBLE_TO_MAP_ONLY;
         }
       }
-      return 0;
+      return NODE_NOT_VISIBLE;
     });
     return visibility;
   }
   console.error("calcVisibility ran without tree.nodes");
-  return 2;
+  return NODE_VISIBLE;
 };
 
-
 export const calculateVisiblityAndBranchThickness = (tree, controls, dates, {idxOfInViewRootNode = 0, tipSelectedIdx = 0} = {}) => {
   const visibility = tipSelectedIdx ? identifyPathToTip(tree.nodes, tipSelectedIdx) : calcVisibility(tree, controls, dates);
   /* recalculate tipCounts over the tree - modifies redux tree nodes in place (yeah, I know) */