@datagrok/peptides 0.8.8 → 0.8.12

package/src/viewers/sar-viewer.ts

@@ -3,394 +3,170 @@ import * as ui from 'datagrok-api/ui';
 import * as DG from 'datagrok-api/dg';
 
 import $ from 'cash-dom';
-import {StringDictionary} from '@datagrok-libraries/utils/src/type-declarations';
+import {PeptidesController} from '../peptides';
+import * as C from '../utils/constants';
+
+let IS_PROPERTY_CHANGING = false;
+
+export class SARViewerBase extends DG.JsViewer {
+  tempName!: string;
+  viewerGrid!: DG.Grid;
+  sourceGrid!: DG.Grid;
+  controller!: PeptidesController;
+  scaling: string;
+  // filterMode: boolean;
+  bidirectionalAnalysis: boolean;
+  // grouping: boolean;
+  showSubstitution: boolean;
+  maxSubstitutions: number;
+  activityLimit: number;
+  _titleHost = ui.divText('SAR Viewer', {id: 'pep-viewer-title'});
+  initialized = false;
+  isPropertyChanging: boolean = false;
 
-import {model} from '../model';
-
-/**
- * Structure-activity relationship viewer.
- *
- * @export
- * @class SARViewer
- * @extends {DG.JsViewer}
- */
-export class SARViewer extends DG.JsViewer {
-  protected viewerGrid: DG.Grid | null;
-  protected sourceGrid: DG.Grid | null;
-  protected activityColumnName: string;
-  protected scaling: string;
-  protected bidirectionalAnalysis: boolean;
-  protected filterMode: boolean;
-  protected statsDf: DG.DataFrame | null;
-  protected initialized: boolean;
-  protected viewGridInitialized: boolean;
-  protected aminoAcidResidue;
-  protected _initialBitset: DG.BitSet | null;
-  protected viewerVGrid: DG.Grid | null;
-  protected currentBitset: DG.BitSet | null;
-  grouping: boolean;
-  groupMapping: StringDictionary | null;
-  // protected pValueThreshold: number;
-  // protected amountOfBestAARs: number;
-  // duplicatesHandingMethod: string;
-
-  /**
-   * Creates an instance of SARViewer.
-   *
-   * @memberof SARViewer
-   */
   constructor() {
     super();
 
-    this.viewerGrid = null;
-    this.viewerVGrid = null;
-    this.statsDf = null;
-    this.groupMapping = null;
-    this.initialized = false;
-    this.aminoAcidResidue = 'AAR';
-    this._initialBitset = null;
-    this.viewGridInitialized = false;
-    this.currentBitset = null;
-
-    //TODO: find a way to restrict activityColumnName to accept only numerical columns (double even better)
-    this.activityColumnName = this.string('activityColumnName');
     this.scaling = this.string('scaling', 'none', {choices: ['none', 'lg', '-lg']});
-    this.filterMode = this.bool('filterMode', false);
+    // this.filterMode = this.bool('filterMode', false);
     this.bidirectionalAnalysis = this.bool('bidirectionalAnalysis', false);
-    this.grouping = this.bool('grouping', false);
-    // this.pValueThreshold = this.float('pValueThreshold', 0.1);
-    // this.amountOfBestAARs = this.int('amountOfBestAAR', 1);
-    // this.duplicatesHandingMethod = this.string('duplicatesHandlingMethod', 'median', {choices: ['median']});
+    // this.grouping = this.bool('grouping', false);
 
-    this.sourceGrid = null;
+    this.showSubstitution = this.bool('showSubstitution', false);
+    this.maxSubstitutions = this.int('maxSubstitutions', 1);
+    this.activityLimit = this.float('activityLimit', 2);
   }
 
-  /**
-   * Initializes SARViewer.
-   *
-   * @memberof SARViewer
-   */
-  init() {
-    this._initialBitset = this.dataFrame!.filter.clone();
-    this.currentBitset = this._initialBitset.clone();
-    this.initialized = true;
-    this.subs.push(model.statsDf$.subscribe((data) => this.statsDf = data));
-    this.subs.push(model.viewerGrid$.subscribe((data) => {
-      this.viewerGrid = data;
-      this.render();
-    }));
-    this.subs.push(model.viewerVGrid$.subscribe((data) => this.viewerVGrid = data));
-    this.subs.push(model.groupMapping$.subscribe((data) => this.groupMapping = data));
+  async onTableAttached() {
+    super.onTableAttached();
+    this.dataFrame.temp[this.tempName] ??= this;
+    this.sourceGrid = this.view?.grid ?? (grok.shell.v as DG.TableView).grid;
+    this.controller = await PeptidesController.getInstance(this.dataFrame);
+    this.controller.init(this.dataFrame);
+    await this.requestDataUpdate();
+
+    // this.subs.push(this.controller.onGroupMappingChanged.subscribe(() => {this.render(true);}));
   }
 
-  /**
-   * Function that is executed when the table is attached.
-   *
-   * @memberof SARViewer
-   */
-  onTableAttached() {
-    this.sourceGrid = this.view.grid;
-    this.sourceGrid?.dataFrame?.setTag('dataType', 'peptides');
-    this.render();
+  detach() {this.subs.forEach((sub) => sub.unsubscribe());}
+
+  render(refreshOnly = false) {
+    if (!this.initialized)
+      return;
+    if (!refreshOnly) {
+      $(this.root).empty();
+      const viewerRoot = this.viewerGrid.root;
+      viewerRoot.style.width = 'auto';
+      this.root.appendChild(ui.divV([this._titleHost, viewerRoot]));
+    }
+    this.viewerGrid?.invalidate();
   }
 
-  /**
-   * Function that is executed when the viewer is detached from the table.
-   *
-   * @memberof SARViewer
-   */
-  detach() {
-    this.subs.forEach((sub) => sub.unsubscribe());
+  async requestDataUpdate() {
+    await this.controller.updateData(this.scaling, this.sourceGrid, this.bidirectionalAnalysis,
+      this.activityLimit, this.maxSubstitutions, this.showSubstitution);
   }
 
-  /**
-   * Function that is executed when the property is changed.
-   *
-   * @param {DG.Property} property New property.
-   * @memberof SARViewer
-   */
-  onPropertyChanged(property: DG.Property) {
+  async onPropertyChanged(property: DG.Property) {
     super.onPropertyChanged(property);
-
-    if (!this.initialized) {
-      this.init();
+    this.dataFrame.tags[property.name] = `${property.get(this)}`;
+    if (!this.initialized || IS_PROPERTY_CHANGING)
       return;
-    }
+      
+    const propName = property.name;
 
-    if (property.name === 'scaling' && typeof this.dataFrame !== 'undefined') {
-      const minActivity = DG.Stats.fromColumn(
-        this.dataFrame!.col(this.activityColumnName)!,
-        this._initialBitset,
-      ).min;
+    if (propName === 'scaling' && typeof this.dataFrame !== 'undefined') {
+      const minActivity = this.dataFrame.getCol(C.COLUMNS_NAMES.ACTIVITY).stats.min;
       if (minActivity && minActivity <= 0 && this.scaling !== 'none') {
         grok.shell.warning(`Could not apply ${this.scaling}: ` +
-          `activity column ${this.activityColumnName} contains zero or negative values, falling back to 'none'.`);
+          `activity column ${C.COLUMNS_NAMES.ACTIVITY} contains zero or negative values, falling back to 'none'.`);
         property.set(this, 'none');
         return;
       }
     }
 
-    this.render();
-  }
-
-  /**
-   * Viewer render function.
-   *
-   * @param {boolean} [computeData=true] Recalculate data.
-   * @memberof SARViewer
-   */
-  async render(computeData = true) {
-    if (!this.initialized)
+    if (!this.showSubstitution && ['maxSubstitutions', 'activityLimit'].includes(propName))
       return;
 
-    //TODO: optimize. Don't calculate everything again if only view changes
-    if (computeData) {
-      if (typeof this.dataFrame !== 'undefined' && this.activityColumnName && this.sourceGrid) {
-        await model?.updateData(
-          this.dataFrame!,
-          this.activityColumnName,
-          this.scaling,
-          this.sourceGrid,
-          this.bidirectionalAnalysis,
-          this._initialBitset,
-          this.grouping,
-        );
-
-        if (this.viewerGrid !== null && this.viewerVGrid !== null) {
-          $(this.root).empty();
-          this.root.appendChild(this.viewerGrid.root);
-          this.viewerGrid.dataFrame!.onCurrentCellChanged.subscribe((_) => {
-            this.currentBitset = applyBitset(
-              this.dataFrame!, this.viewerGrid!, this.aminoAcidResidue,
-              this.groupMapping!, this._initialBitset!, this.filterMode,
-            ) ?? this.currentBitset;
-            syncGridsFunc(false, this.viewerGrid!, this.viewerVGrid!, this.aminoAcidResidue);
-          });
-          this.viewerVGrid.dataFrame!.onCurrentCellChanged.subscribe((_) => {
-            syncGridsFunc(true, this.viewerGrid!, this.viewerVGrid!, this.aminoAcidResidue);
-          });
-          this.dataFrame!.onRowsFiltering.subscribe((_) => {
-            sourceFilteringFunc(this.filterMode, this.dataFrame!, this.currentBitset!, this._initialBitset!);
-          });
-          grok.events.onAccordionConstructed.subscribe((accordion: DG.Accordion) => {
-            accordionFunc(
-              accordion, this.viewerGrid!, this.aminoAcidResidue,
-              this._initialBitset!, this.activityColumnName, this.statsDf!,
-            );
-          });
-        }
-      }
-    }
-    //fixes viewers not rendering immediately after analyze.
-    this.viewerGrid?.invalidate();
+    await this.requestDataUpdate();
+    this.render(true);
   }
 }
 
 /**
- * Vertical structure activity relationship viewer.
- *
- * @export
- * @class SARViewerVertical
- * @extends {DG.JsViewer}
+ * Structure-activity relationship viewer.
  */
-export class SARViewerVertical extends DG.JsViewer {
-  viewerVGrid: DG.Grid | null;
-
-  /**
-   * Creates an instance of SARViewerVertical.
-   *
-   * @memberof SARViewerVertical
-   */
-  constructor() {
-    super();
+export class SARViewer extends SARViewerBase {
+  _titleHost = ui.divText('Monomer-Positions', {id: 'pep-viewer-title'});
+  _name = 'Structure-Activity Relationship';
+  tempName = 'sarViewer';
 
-    this.viewerVGrid = null;
-    this.subs.push(model.viewerVGrid$.subscribe((data) => {
-      this.viewerVGrid = data;
+  constructor() { super(); }
+
+  get name() {return this._name;}
+
+  async onTableAttached() {
+    await super.onTableAttached();
+    this.viewerGrid = this.controller.sarGrid;
+
+    this.subs.push(this.controller.onSARGridChanged.subscribe((data) => {
+      this.viewerGrid = data;
       this.render();
     }));
-  }
 
-  /**
-   * Viewer render function.
-   *
-   * @memberof SARViewerVertical
-   */
-  render() {
-    if (this.viewerVGrid) {
-      $(this.root).empty();
-      this.root.appendChild(this.viewerVGrid.root);
-    }
-    this.viewerVGrid?.invalidate();
+    this.initialized = true;
+    this.render();
   }
-}
 
-function syncGridsFunc(
-  sourceVertical: boolean,
-  viewerGrid: DG.Grid,
-  viewerVGrid: DG.Grid,
-  aminoAcidResidue: string,
-) { //TODO: refactor, move
-  if (viewerGrid && viewerGrid.dataFrame && viewerVGrid && viewerVGrid.dataFrame) {
-    if (sourceVertical) {
-      const dfCell = viewerVGrid.dataFrame.currentCell;
-      if (dfCell.column === null || dfCell.column.name !== 'Mean difference')
-        return;
+  isInitialized() { return this.controller?.sarGrid ?? false; }
 
-      const otherColName: string = viewerVGrid.dataFrame.get('Position', dfCell.rowIndex);
-      const otherRowName: string = viewerVGrid.dataFrame.get(aminoAcidResidue, dfCell.rowIndex);
-      let otherRowIndex = -1;
-      for (let i = 0; i < viewerGrid.dataFrame.rowCount; i++) {
-        if (viewerGrid.dataFrame.get(aminoAcidResidue, i) === otherRowName) {
-          otherRowIndex = i;
-          break;
-        }
-      }
-      if (otherRowIndex !== -1)
-        viewerGrid.dataFrame.currentCell = viewerGrid.dataFrame.cell(otherRowIndex, otherColName);
-    } else {
-      const otherPos: string = viewerGrid.dataFrame.currentCol?.name;
-      if (typeof otherPos === 'undefined' && otherPos !== aminoAcidResidue)
-        return;
+  async onPropertyChanged(property: DG.Property): Promise<void> {
+    if (!this.isInitialized() || IS_PROPERTY_CHANGING)
+      return;
 
-      const otherAAR: string =
-        viewerGrid.dataFrame.get(aminoAcidResidue, viewerGrid.dataFrame.currentRowIdx);
-      let otherRowIndex = -1;
-      for (let i = 0; i < viewerVGrid.dataFrame.rowCount; i++) {
-        if (
-          viewerVGrid.dataFrame.get(aminoAcidResidue, i) === otherAAR &&
-          viewerVGrid.dataFrame.get('Position', i) === otherPos
-        ) {
-          otherRowIndex = i;
-          break;
-        }
-      }
-      if (otherRowIndex !== -1)
-        viewerVGrid.dataFrame.currentCell = viewerVGrid.dataFrame.cell(otherRowIndex, 'Mean difference');
-    }
+    await super.onPropertyChanged(property);
+    IS_PROPERTY_CHANGING = true;
+    this.controller.syncProperties(true);
+    IS_PROPERTY_CHANGING = false;
   }
 }
 
-function sourceFilteringFunc(
-  filterMode: boolean,
-  dataFrame: DG.DataFrame,
-  currentBitset: DG.BitSet,
-  initialBitset: DG.BitSet,
-) {
-  if (filterMode) {
-    dataFrame.selection.setAll(false, false);
-    dataFrame.filter.copyFrom(currentBitset);
-  } else {
-    dataFrame.filter.copyFrom(initialBitset);
-    dataFrame.selection.copyFrom(currentBitset);
+/**
+ * Vertical structure activity relationship viewer.
+ */
+export class SARViewerVertical extends SARViewerBase {
+  _name = 'Sequence-Activity relationship';
+  _titleHost = ui.divText('Most Potent Residues', {id: 'pep-viewer-title'});
+  tempName = 'sarViewerVertical';
+
+  constructor() {
+    super();
   }
-}
 
-function applyBitset(
-  dataFrame: DG.DataFrame,
-  viewerGrid: DG.Grid,
-  aminoAcidResidue: string,
-  groupMapping: StringDictionary,
-  initialBitset: DG.BitSet,
-  filterMode: boolean,
-) {
-  let currentBitset = null;
-  if (
-    viewerGrid.dataFrame &&
-    viewerGrid.dataFrame.currentCell.value &&
-    viewerGrid.dataFrame.currentCol.name !== aminoAcidResidue
-  ) {
-    const currentAAR: string =
-      viewerGrid.dataFrame.get(aminoAcidResidue, viewerGrid.dataFrame.currentRowIdx);
-    const currentPosition = viewerGrid.dataFrame.currentCol.name;
-
-    const splitColName = '~splitCol';
-    const otherLabel = 'Other';
-    const aarLabel = `${currentAAR === '-' ? 'Empty' : currentAAR} - ${currentPosition}`;
-
-    let splitCol = dataFrame.col(splitColName);
-    if (!splitCol)
-      splitCol = dataFrame.columns.addNew(splitColName, 'string');
-
-
-    const isChosen = (i: number) => groupMapping[dataFrame!.get(currentPosition, i)] === currentAAR;
-    splitCol!.init((i) => isChosen(i) ? aarLabel : otherLabel);
-
-    //TODO: use column.compact
-    currentBitset = DG.BitSet.create(dataFrame.rowCount, isChosen).and(initialBitset);
-    sourceFilteringFunc(filterMode, dataFrame, currentBitset, initialBitset);
-
-    const colorMap: {[index: string]: string | number} = {};
-    colorMap[otherLabel] = DG.Color.blue;
-    colorMap[aarLabel] = DG.Color.orange;
-    // colorMap[currentAAR] = cp.getColor(currentAAR);
-    dataFrame.getCol(splitColName).colors.setCategorical(colorMap);
+  get name() {return this._name;}
+
+  async onTableAttached() {
+    await super.onTableAttached();
+    this.viewerGrid = this.controller.sarVGrid;
+
+    this.subs.push(this.controller.onSARVGridChanged.subscribe((data) => {
+      this.viewerGrid = data;
+      this.render();
+    }));
+
+    this.initialized = true;
+    this.render();
   }
-  return currentBitset;
-}
 
-function accordionFunc(
-  accordion: DG.Accordion,
-  viewerGrid: DG.Grid,
-  aminoAcidResidue: string,
-  initialBitset: DG.BitSet,
-  activityColumnName: string,
-  statsDf: DG.DataFrame,
-) {
-  if (accordion.context instanceof DG.RowGroup) {
-    const originalDf: DG.DataFrame = DG.toJs(accordion.context.dataFrame);
-    const viewerDf = viewerGrid.dataFrame;
-
-    if (
-      originalDf.getTag('dataType') === 'peptides' &&
-      originalDf.col('~splitCol') &&
-      viewerDf &&
-      viewerDf.currentCol !== null
-    ) {
-      const currentAAR: string = viewerDf.get(
-        aminoAcidResidue,
-        viewerDf.currentRowIdx,
-      );
-      const currentPosition = viewerDf.currentCol.name;
-
-      const labelStr = `${currentAAR === '-' ? 'Empty' : currentAAR} - ${currentPosition}`;
-      const currentColor = DG.Color.toHtml(DG.Color.orange);
-      const otherColor = DG.Color.toHtml(DG.Color.blue);
-      const currentLabel = ui.label(labelStr, {style: {color: currentColor}});
-      const otherLabel = ui.label('Other', {style: {color: otherColor}});
-
-      const elements: (HTMLLabelElement | HTMLElement)[] = [currentLabel, otherLabel];
-
-      const distPane = accordion.getPane('Distribution');
-      if (distPane)
-        accordion.removePane(distPane);
-
-      accordion.addPane('Distribution', () => {
-        const hist = originalDf.clone(initialBitset).plot.histogram({
-        // const hist = originalDf.plot.histogram({
-          filteringEnabled: false,
-          valueColumnName: `${activityColumnName}Scaled`,
-          splitColumnName: '~splitCol',
-          legendVisibility: 'Never',
-          showXAxis: true,
-          showColumnSelector: false,
-          showRangeSlider: false,
-        }).root;
-        hist.style.width = 'auto';
-        elements.push(hist);
-
-        const tableMap: StringDictionary = {'Statistics:': ''};
-        for (const colName of new Set(['Count', 'pValue', 'Mean difference'])) {
-          const query = `${aminoAcidResidue} = ${currentAAR} and Position = ${currentPosition}`;
-          const textNum = statsDf.groupBy([colName]).where(query).aggregate().get(colName, 0);
-          // const text = textNum === 0 ? '<0.01' : `${colName === 'Count' ? textNum : textNum.toFixed(2)}`;
-          const text = colName === 'Count' ? `${textNum}` : textNum < 0.01 ? '<0.01' : textNum.toFixed(2);
-          tableMap[colName === 'pValue' ? 'p-value' : colName] = text;
-        }
-        elements.push(ui.tableFromMap(tableMap));
-
-        return ui.divV(elements);
-      }, true);
-    }
+  isInitialized() { return this.controller?.sarVGrid ?? false; }
+
+  async onPropertyChanged(property: DG.Property): Promise<void> {
+    if (!this.isInitialized() || IS_PROPERTY_CHANGING)
+      return;
+
+    await super.onPropertyChanged(property);
+    IS_PROPERTY_CHANGING = true;
+    this.controller.syncProperties(false);
+    IS_PROPERTY_CHANGING = false;
   }
 }