@sjcrh/proteinpaint-client 2.210.0 → 2.210.1

package/dist/chunk-TOFOT2BN.js

@@ -0,0 +1,294 @@
+import {
+  getSortOptions
+} from "./chunk-ME325OQC.js";
+import {
+  defaultUiLabels,
+  fillTermWrapper
+} from "./chunk-CSAS3PVJ.js";
+import {
+  isDictionaryType
+} from "./chunk-4Y5W26UF.js";
+import {
+  CNVClasses,
+  dtcnv,
+  mclass,
+  mutationClasses,
+  proteinChangingMutations,
+  synonymousMutations,
+  truncatingMutations
+} from "./chunk-UYKJOBRO.js";
+import {
+  copyMerge
+} from "./chunk-WINIL2KN.js";
+
+// plots/matrix/matrix.config.js
+async function getPlotConfig(opts = {}, app) {
+  const controlLabels = structuredClone(defaultUiLabels);
+  const devicePixelRatio = opts.devicePixelRatio || window.devicePixelRatio;
+  const config = {
+    // data configuration
+    termgroups: [],
+    samplegroups: [],
+    divideBy: null,
+    legendValueFilter: {
+      isAtomic: true,
+      type: "tvslst",
+      in: true,
+      join: "and",
+      lst: []
+    },
+    legendGrpFilter: {
+      isAtomic: true,
+      type: "tvslst",
+      in: true,
+      join: "and",
+      lst: []
+    },
+    filter: {
+      isAtomic: true,
+      type: "tvslst",
+      in: true,
+      join: "and",
+      lst: []
+    },
+    // cnvCutoffs: {},
+    // rendering options
+    settings: {
+      matrix: {
+        svgCanvasSwitch: 1e3,
+        // the number of samples to trigger switching between svg and canvas
+        useMinPixelWidth: true,
+        // canvas may be hazy if false, but more accurately reflects column density
+        cellEncoding: "",
+        // can be "oncoprint" | "stacked" | "single"
+        margin: {
+          top: 10,
+          right: 5,
+          bottom: 20,
+          left: 50
+        },
+        // set any dataset-defined sample limits and sort priority, otherwise undefined
+        // put in settings, so that later may be overridden by a user
+        maxGenes: opts.settings?.maxGenes || 50,
+        maxSample: opts.settings?.maxSample || 1e3,
+        sampleNameFilter: "",
+        sortSamplesBy: "a",
+        sortPriority: void 0,
+        // will be filled-in
+        sortBySampleAncestry: app.vocabApi.termdbConfig.hasSampleAncestry ? "last" : false,
+        // indicates sorting priority by sample ancestry
+        // sortByMutation: 'consequence', computed
+        // sortByCNV: true, computed
+        //sortOptions: getSortOptions(app.vocabApi.termdbConfig, controlLabels),
+        sortSampleGrpsBy: "name",
+        // 'hits' | 'name' | 'sampleCount'
+        sortSamplesTieBreakers: [{
+          $id: "sample",
+          sortSamples: {}
+          /*split: {char: '', index: 0}*/
+        }],
+        sortTermsBy: "sampleCount",
+        // or 'as listed'
+        // do not show number of samples at hiercluster gene row labels
+        samplecount4gene: opts.chartType == "hierCluster" ? "" : "abs",
+        //true, // 'abs' (default, previously true), 'pct', ''  (previously false)
+        geneVariantCountSamplesSkipMclass: [],
+        cellbg: "#ececec",
+        showGrid: "",
+        // false | 'pattern' | 'rect'
+        // whether to show these controls buttons
+        addMutationCNVButtons: false,
+        truncatingMutations,
+        proteinChangingMutations,
+        synonymousMutations,
+        mutationClasses,
+        CNVClasses,
+        gridStroke: "#fff",
+        outlineStroke: "#ccc",
+        beamStroke: "#f00",
+        colw: 0,
+        colwMin: 0.1 / devicePixelRatio,
+        colwMax: 16,
+        colspace: 1,
+        colgspace: 8,
+        colglabelpos: true,
+        collabelpos: "bottom",
+        collabelvisible: true,
+        collabelgap: 5,
+        collabelpad: 1,
+        collabelmaxchars: 32,
+        rowh: 18,
+        //use 0 to auto-compute row height, previous default=18,
+        rowhMin: 1,
+        rowhMax: 20,
+        rowspace: 1,
+        rowgspace: 8,
+        rowlabelpos: "left",
+        // | 'right'
+        rowlabelgap: 5,
+        rowlabelvisible: true,
+        rowlabelpad: 1,
+        rowlabelmaxchars: 32,
+        legendGrpLabelMaxChars: 26,
+        grpLabelFontSize: 12,
+        minLabelFontSize: 6,
+        maxLabelFontSize: 14,
+        transpose: false,
+        // 'auto' shows column labels only when columns are wide enough (colw >= minLabelFontSize);
+        sampleLabelsToggle: "auto",
+        // 'auto' | 'hide'
+        sampleLabelOffset: 120,
+        sampleGrpLabelOffset: 120,
+        sampleGrpLabelMaxChars: 32,
+        termLabelOffset: 80,
+        termGrpLabelOffset: 80,
+        termGrpLabelMaxChars: 32,
+        duration: 0,
+        zoomLevel: 1,
+        zoomCenterPct: 0,
+        zoomIndex: 0,
+        zoomGrpIndex: 0,
+        zoomMin: 0.5,
+        zoomIncrement: 0.1,
+        zoomStep: 1,
+        // renderedWMax should not be exposed as a user-input
+        // 60000 pixels is based on laptop and external monitor tests,
+        // when a canvas dataURL image in a zoomed-in matrix svg stops rendering
+        imgWMax: 6e4 / devicePixelRatio,
+        scrollHeight: 12,
+        controlLabels,
+        cnvUnit: "log2ratio",
+        ignoreCnvValues: false,
+        //will ignore numeric CNV values if true
+        barh: 32,
+        // default bar height for continuous terms,
+        // possible string entries:
+        // - "genesetEdit", for gene-centric embedders only like GDC OncoMatrix
+        // - may add other optional hints later
+        showHints: [],
+        genesetEditUiVersion: "",
+        // '' | 'withTabs'
+        // settings for a specific tw
+        twSpecificSettings: {},
+        oncoPrintSNVindelCellBorder: false,
+        // whether to show white cell border for SNVindel in oncoPrint mode
+        cnvValues: {
+          //Properties match the args for the ColorScales
+          //numericInput arg
+          cutoffMode: "percentile",
+          defaultPercentile: 99,
+          min: null,
+          max: null,
+          percentile: 99
+        }
+      }
+    }
+  };
+  const s = config.settings;
+  const fontsize = Math.max(s.matrix.rowh + s.matrix.rowspace - 3 * s.matrix.rowlabelpad, 12);
+  s.legend = {
+    ontop: false,
+    lineh: 25,
+    padx: 5,
+    padleft: 0,
+    //150,
+    padright: 20,
+    padbtm: 30,
+    fontsize,
+    iconh: fontsize - 2,
+    iconw: fontsize - 2,
+    hangleft: 1,
+    linesep: false
+  };
+  const overrides = app.vocabApi.termdbConfig.matrix || {};
+  copyMerge(config.settings.matrix, overrides.settings);
+  if (overrides.legendGrpFilter) config.legendGrpFilter = overrides.legendGrpFilter;
+  if (overrides.legendValueFilter) config.legendValueFilter = overrides.legendValueFilter;
+  if (overrides.filter) config.filter = overrides.filter;
+  if (opts.name) {
+    const data = await app.vocabApi.getMatrixByName(opts.name);
+    if (!data) throw "error from getMatrixByName()";
+    if (data.error) throw data.error;
+    copyMerge(config, data);
+  }
+  const os = opts?.settings?.matrix;
+  if (os) {
+    if ((os.sortSamplesBy == "custom" || os.sortSamplesBy == "asListed") && os.sortOptions?.custom.label == "against alteration type") {
+      os.sortSamplesBy = "a";
+    }
+    if (os.sortOptions) {
+      delete os.sortOptions.custom;
+      delete os.sortOptions.asListed;
+    }
+  }
+  copyMerge(config, opts);
+  const m = config.settings.matrix;
+  m.sortOptions = getSortOptions(app.vocabApi.termdbConfig, controlLabels, m);
+  m.duration = 0;
+  m.colw = 0;
+  if (m.sortSamplesBy != "asListed" && !m.sortOptions?.[m.sortSamplesBy]) m.sortSamplesBy = "a";
+  else if (["selectedTerms", "class", "dt", "hits"].includes(m.sortSamplesBy)) m.sortSamplesBy = "a";
+  if (m.samplecount4gene === true || m.samplecount4gene === 1) m.samplecount4gene = "abs";
+  if (window.location.hostname == "localhost") {
+    if (window.location.hash == "#canvas") m.svgCanvasSwitch = 0;
+  }
+  for (const grp of config.termgroups) {
+    const promises = [];
+    for (const tw of grp.lst) {
+      if (!tw.term?.type || isDictionaryType(tw.term.type)) {
+        if (!tw.id && tw.term.type != "samplelst" && tw.term.type != "termCollection") {
+          if (!tw.term.id) throw `missing tw.id and tw.term.id`;
+          tw.id = tw.term.id;
+        }
+        if (tw.term?.type != "samplelst" && tw.term?.type != "termCollection") delete tw.term;
+      }
+      promises.push(fillTermWrapper(tw, app.vocabApi));
+    }
+    grp.lst = await Promise.all(promises);
+  }
+  if (config.divideBy) config.divideBy = await fillTermWrapper(config.divideBy, app.vocabApi);
+  return config;
+}
+function setComputedConfig(config) {
+  const s = config.settings.matrix;
+  const allClasses = [...s.mutationClasses, ...s.CNVClasses];
+  s.filterByClass = { isAtomic: true };
+  for (const f of config.legendGrpFilter.lst) {
+    if (!f.dt) continue;
+    allClasses.filter((m) => f.dt.includes(mclass[m].dt)).forEach((key2) => {
+      s.filterByClass[key2] = "value";
+    });
+  }
+  for (const f of config.legendValueFilter.lst) {
+    if (!f.legendGrpName || f.tvs?.term?.type !== "geneVariant") continue;
+    if (f.tvs.values?.[0].mclasslst)
+      f.tvs.values[0].mclasslst.forEach((key2) => {
+        s.filterByClass[key2] = f.legendFilterType?.endsWith("_hard") ? "case" : "value";
+      });
+    else if (f.tvs.values)
+      f.tvs.values.forEach((v) => {
+        s.filterByClass[key] = "value";
+      });
+    else throw `unhandled tvs from legendValueFilter`;
+  }
+  s.hiddenVariants = Object.keys(s.filterByClass).filter((c) => c !== "isAtomic");
+  const hiddenCNVs = new Set(s.hiddenVariants.filter((key2) => mclass[key2]?.dt === dtcnv));
+  s.hiddenCNVs = [...hiddenCNVs];
+  s.showMatrixCNV = !hiddenCNVs.size ? "all" : hiddenCNVs.size == s.CNVClasses.length ? "none" : "bySelection";
+  s.allMatrixCNVHidden = hiddenCNVs.size == s.CNVClasses.length;
+  const hiddenMutations = new Set(s.hiddenVariants.filter((key2) => s.mutationClasses.find((k) => k === key2)));
+  s.hiddenMutations = [...hiddenMutations];
+  const PCset = new Set(s.proteinChangingMutations);
+  const TMset = new Set(s.truncatingMutations);
+  s.showMatrixMutation = !hiddenMutations.size ? "all" : hiddenMutations.size == s.mutationClasses.length ? "none" : hiddenMutations.size === s.mutationClasses.length - PCset.size && [...hiddenMutations].every((m) => !PCset.has(m)) ? "onlyPC" : hiddenMutations.size === s.mutationClasses.length - TMset.size && [...hiddenMutations].every((m) => !TMset.has(m)) ? "onlyTruncating" : "bySelection";
+  s.allMatrixMutationHidden = hiddenMutations.size == s.mutationClasses.length;
+  const tiebreakers = s.sortOptions.a?.sortPriority.find((sp) => sp.types.length == 1 && sp.types[0] == "geneVariant")?.tiebreakers || [];
+  s.sortByMutation = tiebreakers.find((tb) => tb.filter?.values[0]?.dt === 1)?.isOrdered ? "consequence" : "presence";
+  s.sortByCNV = tiebreakers.find((tb) => tb.filter?.values[0]?.dt === 4)?.disabled !== true;
+}
+
+export {
+  getPlotConfig,
+  setComputedConfig
+};
+//# sourceMappingURL=chunk-TOFOT2BN.js.map

package/dist/chunk-UOYIPBTX.js

@@ -0,0 +1,217 @@
+import {
+  DATermTypes,
+  DMRCATE_DEFAULTS
+} from "./chunk-CSAS3PVJ.js";
+import {
+  dofetch3
+} from "./chunk-VTHZGUSZ.js";
+import {
+  DMR_SCAN_ELEMENT_TYPE
+} from "./chunk-UYKJOBRO.js";
+import {
+  rgb
+} from "./chunk-Q5RDQNIT.js";
+
+// plots/volcano/colors.ts
+function getGroupColors(config) {
+  const groups = config?.samplelst?.groups;
+  const termValues = config?.tw?.term?.values;
+  const rawDown = termValues?.[groups?.[0]?.name]?.color || "red";
+  const rawUp = termValues?.[groups?.[1]?.name]?.color || "blue";
+  return {
+    controlColor: toHex(rawDown, "red"),
+    caseColor: toHex(rawUp, "blue")
+  };
+}
+function toHex(color, fallback) {
+  const c = rgb(color || fallback);
+  return c.displayable() ? c.formatHex() : rgb(fallback).formatHex();
+}
+
+// plots/volcano/model/VolcanoModel.ts
+var VolcanoModel = class {
+  /** TODO: This model is used in both the volcano and gsea.
+   * In the future, create base model in DA and use specific
+   * classes for the volcano and gsea. */
+  constructor(plot, termType) {
+    this.plot = plot;
+    this.app = plot.app;
+    this.termType = termType;
+  }
+  /** May use mapper instead as more termTypes are added */
+  async getData(config, settings) {
+    this.config = config;
+    this.settings = settings;
+    if (this.termType === DATermTypes.GENE_EXPRESSION) {
+      const body = await this.getGERequestBody();
+      const response = await dofetch3("termdb/DE", { body, signal: this.plot.api?.getAbortSignal() });
+      if (response && !response.error) response.daRequest = body;
+      return response;
+    }
+    if (this.termType === DATermTypes.DNA_METHYLATION) {
+      const body = await this.getDMRequestBody();
+      const response = await dofetch3("termdb/diffMeth", { body, signal: this.plot.api?.getAbortSignal() });
+      if (response && !response.error) response.daRequest = body;
+      return response;
+    }
+    if (this.termType === DATermTypes.SINGLECELL_CELLTYPE) {
+      const body = await this.getSCCTRequestBody();
+      return await dofetch3("termdb/singlecellDEgenes", { body, signal: this.plot.api?.getAbortSignal() });
+    }
+    if (this.termType === DATermTypes.PROTEOME_DAP) {
+      const body = this.getDapRequestBody();
+      return await dofetch3("termdb/dapVolcano", { body, signal: this.plot.api?.getAbortSignal() });
+    }
+    if (this.termType === DATermTypes.SINGLECELL_GENE_EXPRESSION) {
+    }
+    throw new Error(`Volcano plot does not support route for termType='${this.termType}'`);
+  }
+  //Gene expression
+  async getGERequestBody() {
+    await this.getOtherSamples(this.config.samplelst);
+    const state = this.app.getState();
+    const body = {
+      kind: "DE",
+      genome: this.app.vocabApi.vocab.genome,
+      dslabel: this.app.vocabApi.vocab.dslabel,
+      method: this.settings.method,
+      min_count: this.settings.minCount,
+      min_total_count: this.settings.minTotalCount,
+      samplelst: this.config.samplelst,
+      filter: state.termfilter.filter,
+      filter0: state.termfilter.filter0,
+      cpm_cutoff: this.settings.cpmCutoff,
+      volcanoRender: this.getVolcanoRender()
+    };
+    const pseudobulk = this.config.tw?.pseudobulk;
+    if (pseudobulk) body.pseudobulk = pseudobulk;
+    this.addConfounderTw(body);
+    return body;
+  }
+  //DNA methylation
+  async getDMRequestBody() {
+    await this.getOtherSamples(this.config.samplelst);
+    const state = this.app.getState();
+    const body = {
+      kind: "DM",
+      genome: this.app.vocabApi.vocab.genome,
+      dslabel: this.app.vocabApi.vocab.dslabel,
+      samplelst: this.config.samplelst,
+      filter: state.termfilter.filter,
+      filter0: state.termfilter.filter0,
+      min_samples_per_group: this.settings.minSamplesPerGroup,
+      exclude_sex_chr: this.settings.excludeSexChr,
+      /* Omitted rather than sent as 'promoter' when it is the default, so a request
+      from a promoter-only dataset is byte-identical to what this client sent before
+      the element picker existed. The server resolves an absent element_type to
+      'promoter'. This does NOT preserve cache keys -- the key object gained the
+      field server-side, so every pre-existing dm/ entry is orphaned on deploy
+      regardless of what the client sends. */
+      ...this.settings.elementType && this.settings.elementType != "promoter" ? { element_type: this.settings.elementType } : {},
+      // the scan's own knobs; the server ignores them for any other element type
+      ...this.settings.elementType == DMR_SCAN_ELEMENT_TYPE ? {
+        scan: {
+          ...this.settings.scanChromosome ? { chromosome: this.settings.scanChromosome } : {},
+          backgroundCorrection: !!this.settings.backgroundCorrection,
+          minCpgs: this.settings.minCpgs,
+          profileBinBp: this.settings.profileBinBp,
+          // only when changed: an explicit default would orphan every cached scan
+          ...this.settings.lambda != DMRCATE_DEFAULTS.lambda ? { lambda: this.settings.lambda } : {},
+          ...this.settings.C != DMRCATE_DEFAULTS.C ? { C: this.settings.C } : {},
+          ...this.settings.fdrCutoff != DMRCATE_DEFAULTS.fdrCutoff ? { fdrCutoff: this.settings.fdrCutoff } : {}
+        }
+      } : {},
+      volcanoRender: this.getVolcanoRender()
+    };
+    if (this.settings.elementType != DMR_SCAN_ELEMENT_TYPE) this.addConfounderTw(body);
+    return body;
+  }
+  /** Parameters telling the server to run the `volcano` Rust renderer and return a
+   * volcano PNG + top-significant rows instead of the full dot list. */
+  getVolcanoRender() {
+    const dotRadius = Math.max(this.settings.width, this.settings.height) / 80;
+    const { caseColor, controlColor } = getGroupColors(this.config);
+    const useDeltaBeta = this.termType === DATermTypes.DNA_METHYLATION && this.settings.xAxis == "delta_beta";
+    return {
+      significanceThresholds: {
+        pValueCutoff: this.settings.pValue,
+        pValueType: this.settings.pValueType,
+        foldChangeCutoff: useDeltaBeta ? this.settings.deltaBetaCutoff : this.settings.foldChangeCutoff
+      },
+      ...useDeltaBeta ? { xField: "delta_beta" } : {},
+      // Tied to the delta-beta axis: the control that sets it is only offered for
+      // methylation, and centering a log2 fold-change axis is a different conversation.
+      ...useDeltaBeta && this.settings.centerDeltaBeta ? { centerX: true } : {},
+      pixelWidth: this.settings.width,
+      pixelHeight: this.settings.height,
+      colorSignificant: toHex(this.settings.defaultSignColor, "red"),
+      colorSignificantUp: caseColor,
+      colorSignificantDown: controlColor,
+      colorNonsignificant: toHex(this.settings.defaultNonSignColor, "black"),
+      dotRadius,
+      maxInteractiveDots: this.settings.maxInteractiveDots,
+      // Render the PNG at device-pixel resolution so it stays sharp on
+      // retina screens. The server reports the plot extent in CSS-space,
+      // so SVG overlay coords are unaffected.
+      //
+      // Oversample by 2× so the PNG also stays sharp when the user
+      // *zooms in after* the initial render (the captured DPR is frozen
+      // at fetch time — bigger headroom = more tolerable post-render
+      // zoom before pixelation appears). The server clamp keeps the
+      // bitmap memory bounded.
+      devicePixelRatio: (typeof window !== "undefined" ? window.devicePixelRatio : 1) * 2
+    };
+  }
+  //This is a workaround until the server can accept an arr of confounder tws
+  addConfounderTw(body) {
+    const confounders = this.config?.confounderTws;
+    if (confounders?.length) {
+      body.tw = this.config.confounderTws[0];
+      if (confounders.length > 1) body.tw2 = this.config.confounderTws[1];
+    }
+  }
+  //Single cell cell type
+  getSCCTRequestBody() {
+    const body = {
+      genome: this.app.vocabApi.vocab.genome,
+      dslabel: this.app.vocabApi.vocab.dslabel,
+      sample: this.config.sample,
+      termId: this.config.termId,
+      categoryName: this.config.categoryName,
+      volcanoRender: this.getVolcanoRender()
+    };
+    return body;
+  }
+  getDapRequestBody() {
+    const { organism, assay, cohort } = this.config.proteomeDetails;
+    return {
+      genome: this.app.vocabApi.vocab.genome,
+      dslabel: this.app.vocabApi.vocab.dslabel,
+      organism,
+      assay,
+      cohort,
+      volcanoRender: this.getVolcanoRender()
+    };
+  }
+  /** retrieve the sampleId/sampleName for samples in
+   * the "others" group instead of using {in: false} */
+  async getOtherSamples(samplelst) {
+    const othersSamplesGroup = samplelst.groups.find((g) => !g.in);
+    if (!othersSamplesGroup) return;
+    const state = this.app.getState();
+    const samplesGroup = samplelst.groups.find((g) => g.in);
+    othersSamplesGroup.values = [];
+    for (const s of await this.plot.vocabApi.getFilteredSampleList(state.termfilter.filter)) {
+      if (!samplesGroup.values.some((i) => i.sampleId == s.id)) {
+        othersSamplesGroup.values.push({ sampleId: s.id, sample: s.name });
+      }
+    }
+    othersSamplesGroup.in = true;
+  }
+};
+
+export {
+  getGroupColors,
+  VolcanoModel
+};
+//# sourceMappingURL=chunk-UOYIPBTX.js.map