reorder metadata legend before results

[ziyuan-linn]

This PR fixes #180 by sorting Object.entries(legend) via the one hot array, ensuring that its ordering matches the ordering of unformattedResults.

[lindapaiste]

Can you explain what this sort function is doing? It’s not clear at first glance.

It does feel like this is a roundabout solution. It’s probably fine for now to just fix the issue but I wonder if there’s a better way to structure the metadata objects to avoid the issue.

[ziyuan-linn]

Thank you for pointing out the ambiguity. I also added a comment in the code.

This function reorders the Object.entries(legend) array from something like:

[
  ["1", [0, 1, 0, 0],
  ["2", [1, 0, 0, 0],
  ["3", [0, 0, 0, 1],
  ["4", [0, 0, 1, 0],
]

to:

[
  ["2", [1, 0, 0, 0],
  ["1", [0, 1, 0, 0],
  ["4", [0, 0, 1, 0], 
  ["3", [0, 0, 0, 1],
]

I agree that a better long-term solution is to restructure the metadata object. Perhaps we can track this in a new issue or add something to #112.

[shiffman]

@ziyuan-linn I'm going to go ahead and merge this for the "bug fix" but feel free to open an issue or add to an issue's discussion!

[lindapaiste]

I think you could get the same sort order with vals.sort((a, b) => a[1].indexOf(1) - b[1].indexOf(1)). Personally I find .indexOf(1) more clear than .reduce((acc, curr) => acc * 2 + curr, 0), but this is already merged so no big deal.