1. Byosphere® Dashboards (Powered by Deep Query)
1.1. Overview
Byosphere® Deep Query allows a user to collate data to build Visualizations. Features include:
- Multiple customizable Visualization types that can be used to represent data
- Query all PMI analyzed data and upload data and projects into Byosphere to use with Deep Query in real-time
- Access to building and viewing Dashboards within the Byosphere Web Client—no additional software required
- Leverage the use of Metadata within Visualizations
- Add user-defined Derived Fields to a Visualization
- Build different data value transformations and calculated fields to apply to data
- Background Alerts to notify the user when certain conditions have been met for data within a Dashboard
1.2. User Privileges
To use Deep Query, users must have at least the Advanced Viewer or Contributor Role. Basic Viewers do not have access to Deep Query.
1.3. Introduction
Byosphere® Deep Query Dashboards allow a user to interrogate data from multiple projects within a Data Source to provide detailed information. Dashboards are a collection of Visualizations that support viewing data across multiple projects. They provide a dynamic view of data that can be used to monitor processes, assess changes over time, or to create descriptive models of data for business intelligence purposes. A Visualization is a chart, table, or other kind of visual component that renders data.
1.4. Load a Dashboard
To load a Dashboard that has already been created, the user must select a Dashboard from the list of all Dashboards the user has been given Viewer privileges to. If a user wishes to Edit or Publish a Dashboard, they must have Viewer and File Editor privileges. The file name extension for Dashboards is .bdash.
Figure 1.1 View Dashboard button in the Actions column
Actions available for the files listed under the Dashboards tab differ from options available for other files by the presence of the View Dashboard icon . Clicking on View Dashboard will launch the selected Dashboard. For more information on additional Action icons available in the Web Client, see the Byosphere Web Client Manual.
Once a Dashboard is loaded, the user can freely move between tabs of Byosphere within the same browser and any edits made to the Dashboard and associated Visualizations will be retained.
1.4.1. File History
Users can view all published versions of a Dashboard by clicking the File History icon within the File Browser page.
File History for Dashboard documents performs similarly to any other document within the Byosphere Web Client, with the following exceptions for the Change column:
- The Change column will read Create Content when the Dashboard file is first created from the Dashboard Editor
Figure 1.2 Change Column for new Dashboards
- The Change column will read Edit Content when the Dashboard is edited and Published
Figure 1.3 The Change column for the same Dashboard after being published
1.5. Create a Dashboard
1.5.1. Using a Template
Users will be provided with different types of example/template dashboards under System Dashboards, which can be found on the Deep Query Dashboards page.
Figure 6: System Dashboards from the Home page
1.5.1.1. Peptide templates
The PTM Dashboard Template can be used to deep query across different analyses for post translational modifications (PTMs). The PTM Dashboard Template contains the following visualizations:
- Pivot table for Relative Glycosylation Short Name: This converts the glycan subunit name from the glycopeptide identification to short name nomenclature. For example: HexNAc(4)Hex(3)Fuc(1) to G0F. This will then calculate the relative % of each Glycan that is identified.
- Stacked bar chart for Stacked Bar Chart Glycan Distribution: This is the same as the pivot table described above but presented in a stacked bar chart.
- Pivot table for Relative Fucosylation %: This will categorize glycopeptides into a-Fucose (where the Glycan does not contain a Fucose) and Fucose (where the identified Glycan does contain a Fucose). The relative % between these two categories is then calculated.
- Bar chart for Relative Fucosylation %.: This is the same as the pivot table described above but presented in a bar chart.
- Pivot table for % Modification (Multiple Mods per Peptide): This table is the same as the pivot table used in Byos reports to quantitate the relative levels of modified and unmodified peptides. Normalization occurs at the peptide level. By default, the unmodified (or Wild Type) peptides are hidden using a filter. This filter may be removed by editing the visualization and going to the Filter and Sort tab. The filter is applied as a Show/Hide filter and can be removed simply by deleting the filter.
- Line chart for % Modification (Multiple Mods per Peptide) Trend for Indicator Peptides: This allows the user to monitor a trend of defined peptides and is useful for monitoring trends over time of a modification; for example, % oxidation between samples. This uses the same normalization calculation as the previous pivot table. A user may define their own peptides and modifications by using the filters. An Include/Exclude filter may be used for the peptide sequence, as normalization occurs at the peptide level. However, it is important to remember to define specific modification information using a Show/Hide filter, so it will not affect the normalization calculation.
- Pivot Table for Average XIC Ratio Percent of Modifications per Peptide: This will show the XIC ratio percent of modified peptides per sample.
The PTM Oxidation Dashboard Template can be used to deep query across different analyses for oxidation as a post translational modification (PTM).
This template contains the following Visualizations:
- Line chart for % Oxidation Modification (Multiple Mods per Peptide) Trend for Indicator Peptides: This allows the user to monitor a trend of defined peptides and is useful for monitoring oxidation trends over time. This uses the same normalization calculation as the pivot tables in the Dashboard. A user may define their own peptides and modifications by using the filters, and the template is filtered for a specific peptide as an example, which may be changed after Dashboard creation. An Include/Exclude filter may be used for the peptide sequence, as normalization occurs at the peptide level. However, it is important to remember to define specific modification information using a Show/Hide filter, so it will not affect the normalization calculation.
- Pivot table for % Oxidation Modification (Multiple Mods per Peptide): This table is similar to the pivot table used in Byos reports and is used to quantitate the relative levels of modified and unmodified peptides. Normalization occurs at the peptide level. By default, the unmodified (or Wild Type) peptides are hidden using a filter. This filter may be removed by editing the visualization and going to the Filter and Sort tab. The filter is applied as a Show/Hide filter and can be removed simply by deleting the filter.
- Pivot table for Average XIC Ratio Percentage of Oxidations per Peptide: This pivot table is used to calculate the average XIC ratio across all charge states for a modified peptide for each sample.
The System Suitability Dashboard Template can be used for the suitability assessment of LC-MS/MS systems or sample preparation. The following visualizations can be useful for monitoring LC-MS/MS system performance:
- Most Recent ppm: This visualization is presented as a gauge on the Dashboard, where a user can define the range in which a ppm is acceptable (by default this is green) and red where the value falls outside of the defined range. Settings for the gauge visualization may be configured under the Visualization Settings tab when editing the visualization. By default, this visualization is monitoring the most recent project file or a specific peptide, defined by its sequence. The peptide sequence to be monitored and the number of n most recent project to be queried may be defined in the Filter and Sort tab when editing the visualization.
- Line Chart for Average ppm trend: This chart will display the average ppm of all peptides within a given sample file over time (average ppm vs Created On Date).
- Line Chart for Retention Time Trend: This shows the average intensity of an XIC peak apex vs Created On Date for a single peptide. A user may define a custom peptide and/or instrument in the Include/Exclude filters when editing the visualization.
There are also visualizations within the System Suitability Template that will allow a user to monitor parameters related to sample preparation, such as:
- Pivot Table to monitor over and under alkylation of peptides: Peptides are categorized into those that have been under alkylated, those that have been over alkylated, and all other peptides. The filters applied only include those peptides that are under- or over-alkylated. Categorization is dependent upon the modification names provided in the Byos project. Over alkylated peptides must contain the name “overalkylation” and under alkylated peptides must contain the name “(de) carboxymethyl” in their modification names. Here, the values are determined by averaging the XIC Ratio Percent.
- Bar chart to monitor alkylation levels: This is the same as the pivot table described above but presented in a bar chart.
- Pivot Table to calculate the relative % of missed cleavages: This will calculate the relative levels of miss cleaved peptides. This visualization will only populate for those analyses that have their enzyme defined.
- Bar chart displaying the relative % of miss cleaved peptides: This is the same as the pivot table described above but presented in a bar chart.
- Data Grid for Digestion Specificity : This will calculate the average level of non-specific cleavages.
- Bar Chart for Digestion Specificity: This is the same as the pivot table described above but presented in a bar chart.
The MAM Dashboard Template can be used to deep query results across different peptide analysis projects for MAM studies. The MAM Dashboard Template contains the following Visualizations:
- Line chart – Monitoring of CQA Peptide Levels This displays the relative % modification of peptides that have the label CQA (Critical Quality Attributes) and is useful for monitoring trends over time of those peptides. For example, a user would be able to monitor the relative % oxidated peptides across samples. This uses a similar Normalization calculation as used in the default Byos PTM Report to calculate relative % of different peptide species (% Mod (Multi Mods per Peptide)). There is a Show/Hide filter applied to only display those peptides which were set to have the label CQA within the BYOS project. An Include/Exclude filter may be used for the peptide sequence, as Normalization occurs at the peptide level. However, it is important to remember to only use a Show/Hide filter on the following data fields: Modifications Summary List, and Label Names, so it will not affect the normalization calculation.
- Data Grid – Fold Change from Reference for All Peptides XIC AUCs (Filtered >=4 Fold Change from Reference): This data grid will display the XIC AUC of peptides and the fold change of that XIC AUC in samples that have been classified as Non-Reference Sample Type vs a sample that has been given the Sample Type Reference within a Byos project. There is a default Show/Hide filter applied to only display those peptides that have a fold change of >= 4 in Non-Reference data type samples compared to a Reference data type sample. This value can be changed by a user in the Filter & Sort tab when editing the visualization. All Non-Reference samples are compared to a single Reference, which is important to keep in mind when querying multiple projects. At this time, the Visualization will only support one sample defined with the Sample Type Reference from a Byos Project.
- Pivot Table – Fold Change from Unknown XIC AUCs (Filtered >=4 Fold Change from Reference): This data grid will display the XIC AUC of unknown but detected peaks and fold change of that XIC AUC in samples that have been classified as a Non-Reference Sample Type vs a sample that has been given the Sample Type Reference within a Byos project. This is calculated for unknown XICs that were found as a result of running the feature finder algorithm in Byos. These unknown XICs are not linked with any peptide identification, so this visualization will allow a user to monitor levels of XICs that have not previously been identified. There is a default Show/Hide filter applied to only display those unknown XICs that have a fold change of >= 4 in Non-Reference Sample Type samples compared to a Reference Sample Type sample. This value can be changed by a user in the Filter & Sort tab when editing the visualization. All Non-Reference samples are compared to a single Reference. At this time the visualization will only support one sample defined with the Sample Type Reference from a Byos Project. If queried Byos projects do not contain any of these unknown XICs (for example, if feature finder had not been implemented for that project), the visualization will be empty.
- Pivot table for Relative Glycosylation Short Name: This converts the glycan subunit name from the glycopeptide identification to a short name nomenclature. For example: HexNAc(4)Hex(3)Fuc(1) to G0F. This will then calculate the relative % of each Glycan that is identified.
- Stacked bar chart for Stacked Bar Chart Glycan Distribution: This is the same as the pivot table described above but presented in a stacked bar chart.
- Bar Chart – Fold Change from Unknown Peaks: This bar chart displays the fold change of all unknown XIC AUCs for Non-Reference samples vs a Reference sample and is grouped based upon MS Alias Name. There is a visual indicator (dotted constant red line) set to a value of 4, to enable a user to readily view samples that contain unknown peaks where the value of XIC AUC has increased >= 4 fold from the reference sample. This setting can be changed in the Constant Lines section of the Visualization Settings tab when customizing the visualization.
- CQA and Peptide Labels % All Modifications (Multiple Mods per Peptide): This table is the same as the pivot table used in Byos reports used to quantitate the relative levels of modified and unmodified peptides and also uses the same Normalization calculation as described in the Visualization below. By default, there is a Show/Hide filter to only display the relative % of those peptides which were set to have the label CQA within the BYOS project. In addition, there is a column to display Peptide Label. The Label is concatenated from the Protein Alias Name, and the start/end peptide number.
- Pivot table for % Modification (Multiple Mods per Peptide): This table is the same as the pivot table used in Byos reports used to quantitate the relative levels of modified and unmodified peptides. Normalization occurs at the peptide level. By default, the unmodified (or Wild Type) peptides are hidden using a filter. This filter may be removed by editing the Visualization and going to the Filter and Sort tab. The filter is applied as a Show/Hide filter and can be removed simply by deleting the filter.
- % Deamidation - (Multiple Mods per Peptide): This table is the same as the pivot table explained above, except there is a Show/Hide filter applied to only display deamidated peptides.
- % Oxidation - (Multiple Mods per Peptide): This table is the same as the pivot table explained above, except there is a Show/Hide filter applied to only display oxidated peptides.
- Line chart Trend of Sum of Deamidation XIC AUC per Residue: This line chart monitors the trend of XIC levels for residues such as Q and N that have been deamidated. Each data point represents the sum of the XICs for peptides that contain that residue that has been deamidated. This allows the user to monitor a trend of instrument response dependent level of total deamidations on their proteins across different samples (as we are reporting an XIC value not a relative quantitative value).
- Average XIC Ratio of Modifications per Region: This pivot table is similar to the pivot table % Mod by ModName across Samples in the default PTM template used in Byos reports, which is used to report the average XIC ratio for different modifications at different protein positions, across samples. In this Visualization, these values are displayed alongside the protein region, as defined via Protein Annotation in Byos (such as CDR regions of mAbs). There is an Include/Exclude filter applied to only display those XIC ratio values that related to parts of the protein sequence that have a designated Protein Annotation.
- Bar chart of % Oxidation per Sample and Region: This Bar Chart displays the relative% of oxidated peptides per Sample, per Region (where there may be differing CDR locations such as CDR-L1, CDR-H3 etc). By default, it will only display oxidated peptides that are within a sequence position that is covered by a Protein Annotation within Byos (there is a Show/Hide filter to only display peptides that are oxidated and contain a Protein Annotation). This Bar Chart uses the same Normalization calculation as in the other relative peptide quantitation Visualizations
- in tabular form.
The HCP Dashboard template facilitates the querying of projects focused on discovery, analysis, and monitoring of Host Cell Proteins (HCPs) by mass spectrometry and contains the following Visualizations:
- Relative Protein Abundance - Top 3 Peptides per Protein: This pivot table shows the relative protein abundance within a sample based on top 3 peptides for each named protein.
- XIC AUC - Top 3 Peptides per Protein: This pivot table shows the XIC AUC values of the top 3 peptides for each named protein across samples and replicates.
- Relative Protein Abundance - All Peptides per Protein: This pivot table shows the relative protein abundance based on all detected peptides for each named protein across samples and replicates.
- XIC AUC - All Peptides per Protein: This pivot table shows the XIC AUC for all detected peptides for each named protein.
- Bar Chart - HCPs per Sample (All Peptides): This bar chart shows the relative levels of HCPs per sample based on all peptides detected by protein.
- Error Bar Chart per Sample - HCPs per Sample (All Peptides): This bar chart shows the average relative levels of HCPs per sample for all peptides with error bars conveying variation amongst replicates.
The Multi-Protein Quant Dashboard template for HCPs. The Multi-Protein Quant Dashboard template for HCPs contains the following Visualizations:
- Pivot Table - XIC AUC Protein Abundance - With Peptides: This pivot table provides a tabular representation of the XIC AUC levels of the top 3 peptides per protein.
- Pivot Table - Total XIC Area Summed per Protein: This pivot table provides a tabular representation of the summed XIC AUC levels per protein.
- Bar Chart - Total XIC Area Summed per Protein with Standard Deviation Error Bars: This bar chart is to visualize proteins based on the summed XIC AUC levels using Protein Accession Numbers as X-axis value, hiding the most abundant protein to better visualize the lower level host cell contaminants.
- Pivot Table - Relative Protein Abundance - With Peptides: This pivot table provides a tabular representation of the relative levels of top 3 peptide per protein displayed relative to the most abundant peptide.
- Pivot Table - Relative Protein Abundance: This pivot table provides a tabular representation of the relative protein levels based on summed XIC area and relative to the most abundant protein.
- Bar Chart - Relative Protein Abundance: This bar chart is to visualize the relative protein levels based on XIC quantitation and relative to the most abundant protein
- Stacked Bar Chart - Relative Protein Abundance: This bar chart is to visualize the relative protein levels based on XIC quantitation and normalized to total protein abundance.
- Pivot Table - Protein ppm Concentration – Relative to mAb: This Pivot Table provides the average protein ppm concentration based upon the mAb across different replicates and conditions.
- Stacked Bar Chart – Protein ppm Concentration: This bar chart is used to visualize the relation outlined above.
1.5.1.2. Intact templates
The Intact Protein Dashboard Template facilitates queries across different analyses for Intact Proteoform analysis. The Intact template contains the following Visualizations:
- Pivot Table for All Mass Intensity: This pivot table is used to display the mass intensity for each mass peak. This includes all mass peaks, both identified and non-identified. Grouping is by sample and peak number.
- Pivot Table for Expected Mass Intensity: This pivot table is used to display the mass intensity for identified mass peaks only. Grouping is by sample and peak number.
- Pivot Table for Expected Mass Relative % Modification: Normalization occurs at the protein level and is grouped by sample and peak number.
- Bar Chart – Relative % Modification grouped by Sample Name/Peak Number/Protein (Expected Mass): This is the same as the pivot table described above but presented in a bar chart.
- Pivot Table for Expected mass – mass accuracy (ppm): This pivot table is used to display the mass accuracy in ppm for identified mass peaks. Grouping is by sample and peak number.
- Line Chart Expected mass – mass accuracy (ppm): A line chart displaying the same information as described in the pivot table above.
The ADC Dashboard Template facilitates queries across different analyses for Antibody Drug Conjugate (ADC) and Drug to Antibody Ratio (DAR) analysis. The ADC template contains the following Visualizations:
- Bar Chart – DAR per Sample: This bar chart is used to display the calculated DAR per sample (and is grouped by sample name).
- Bar Chart – Relative % Drug Count per Sample: This bar chart is used to display the relative % of conjugated mAb/ADC species distinguished by the number of drugs conjugated to the antibody. Normalization occurs at the protein level and calculates the relative % based on mass intensities per different delta mass species for the same protein (in this case, n-drug). Bars are grouped by sample and peak number.
- Pivot Table for Expected Mass Intensity: This pivot table is used to display the mass intensity for identified mass peaks only. Grouping is by sample and peak number.
- Pivot Table for Relative % Drug Count and DAR: This pivot table is used to display the relative % of ADC species (specified in the Visualization as modifications determined by delta mass) and calculated DAR value. Normalization occurs at the protein level and is grouped by sample and peak number.
- Pivot Table for Expected mass – mass accuracy (ppm): This pivot table is used to display the mass accuracy in ppm for identified mass peaks. Grouping is by sample and peak number.
- Line Chart Expected mass – mass accuracy (ppm): A line chart displaying the same information as described in the pivot table above.
- Pivot Table for Expected Mass Relative Intensity: This pivot table is used to display the relative % of matched masses per delta masses. Normalization occurs at the protein level and is grouped by sample and peak number.
- Pivot Table for All Mass Intensity: This pivot table is used to display the mass intensity for each deconvoluted mass peak. This includes all mass peaks, both identified and unidentified. Grouping is by sample and peak number.
The Intact Oligonucleotide template facilitates the querying of results across different analyses for Intact Oligonucleotide analysis and contains the following Visualizations:
- All Oligo Mass Intensity: This pivot table displays the mass intensity for all deconvoluted masses per sample.
- Expected Oligo Mass Intensity: This pivot table displays the mass intensity for all expected and identified oligonucleotide species per sample.
- Expected Oligo Mass – Relative Intensity %: This pivot table displays the relative intensity% for all identified expected oligonucleotide species per sample.
- Expected Oligo Mass – Mass Accuracy (ppm): This pivot table displays the mass accuracy in ppm of all identified expected oligonucleotides per samples.
- Bar Chart - Expected Mass Relative Intensity % Across Sample: This bar chart displays the mass accuracy in ppm of all identified expected oligonucleotides per sample.
- Bar Chart - Expected Mass Relative Intensity % per Oligo Candidate: This bar chart displays the mass accuracy in ppm of all identified expected masses per sample.
- Line Chart Expected Oligo - Mono Mass Accuracy (ppm): This line chart displays the monoisotopic mass accuracy per sample.
1.5.1.3. Chromatogram templates
The Chromatogram Comparison template contains the following Visualizations:
- Line Chart Displaying Norm Peak Area for each Peak across Multiple Samples: This line chart is to visualize the normed peak area trends for the same peak across different samples for monitoring purposes
- Bar Chart - Relative Trace Peak Area Grouped by Peaks Comment: This bar chart is to visualize the relative normalized trace peak area values within a group of peaks of interest when identified to belong to a group by a Peak Comment.
- Pivot Table - Trace Peak Area Grouped by Peaks Comment: This Pivot table is a tabular representation of trace peak area values for peaks of interest when identified to belong to a group by a Peak Comment.
- Bar Chart Average Apex Time (minutes) per Peak across Samples (Error bar +/- 3 Std. Dev): This line chart is to visualize apex time consistency and standard deviations across samples within a comparison study.
- Scatter Plot Average Apex time per peak across samples (Error bar +/- 2 Std. Dev) for monitored peaks: This scatter plot is to visualize the same apex time monitoring for a selected few peaks of interest with 2*standard deviation as error bar.
- Bar Chart - Normalized Peak Area % All Peaks: This bar chart is to visualize the normed area values for peaks across samples to allow observation of obvious deviations.
- Bar Chart Average Normed Are% per Peak across Samples (Error bar +/- 1 Std. Dev): This bar chart is to visualize average normed area with standard deviation for peaks across samples.
- Line Chart Average Normed Area% per Peak per Sample filtered for monitored peaks: This line chart is to visualize average normed area for peaks across samples to present visual differences between samples.
- Pivot Table – Normed Area% - All Peaks: This pivot table is a tabular representation of normed area% values of all peaks across samples.
The Released Glycan template can facilitate the querying of projects focused on the characterization of glycans and contains the following Visualizations:
- Annotations by Peak# - Normed Area % - based Relative Glycan Quantitation: This pivot table displays relative glycan levels per sample glycans shown by chromatographic peak within the table.
- Annotations by Glycan - Normed Area % - based Relative Glycan Quantitation This pivot table displays relative glycan levels by glycan short name.
- Glycan Area Bar Chart - Normed Area % Grouped Across Samples: This bar chart shows normed area% for glycans grouped across samples.
- Peak Area Bar Chart - Normed Area % Across Samples: This bar chart shows normed area% for glycans grouped across peaks and samples.
- Bar Chart - Normed Area % for Each Glycan: This bar chart shows normed area% per glycan as resulted in the released glycan analysis.
- Line Chart - Normed Area % for Each Glycan Peak across Samples: This line chart shows normed area% for each glycan peak across samples.
1.5.1.4. Combined templates
The Multi-level Glycosylation Dashboard Template uses the Combined Analysis data source, which ingests data from both Intact and Peptide projects. This template can be used for mapping glycosylation levels and distribution using both Intact and Peptide assay results within one Dashboard.
- Pivot Table for Expected Mass Relative % Glycosylation (Intact Protein Analysis): This pivot table is used to quantitate the relative levels of Glycans on proteins from intact analysis.
- Stacked Bar Chart showing the Relative Levels of Glycans per Sample and Protein: This is the same as the pivot table described above but presented in a stacked bar chart.
- Pivot Table for Relative Glycosylation Distribution of Glycopeptides: This converts the glycan subunit name from the glycopeptide identification to short name nomenclature. For example: HexNAc(4)Hex(3)Fuc(1) to G0F. This will then calculate the relative % of each Glycan that is identified.
- Stacked Bar Chart Glycan Distribution (Glycopeptide Quantitation): This is the same as the pivot table described above but presented in a bar chart.
- Stacked Bar Chart - Glycan Distribution (Released Glycan Analysis): This bar chart shows the relative% of different glycans for samples processed in Released Glycan analysis projects.
- Glycan Distribution (Released Glycan Analysis): This pivot table shows the same information
The Biophysical data correlation template uses the Biophysical Analysis data source, which ingests data from both Intact and Peptide projects that are correlated with Biophysical data. This template can be used for comparing results from Biophysical analyses such as ICIEF, CE-SDS, and SEC to Byos Intact and Byos Peptide results, respectively.
- Pivot Table - iciEF - Comparing Relative % of Trace Peak Area across Biophysical Data Samples: This pivot table provides a tabular representation of relative % trace peak area across samples (using icIEF Biophysical data).
- Pivot Table - SEC - Comparing Relative % of Trace Peak Area across Biophysical Data Samples: This pivot table provides a tabular representation of relative % trace peak area across samples (using SEC Biophysical data).
- Pivot Table (icIEF vs Peptide MS) - Comparing % Deamidation of a Specific Peptide at Different Residue Positions vs % Acidic Peak Area: This pivot table is used to visualize % deamidation for the same peptide at different residue positions and their relationship with % acidic peak area coming from an icIEF analysis of the same sample.
- Pivot Table (Peptide MS) - Relative % Modification at Protein Position across Samples): This pivot table provides a tabular representation of relative % modifications at specific positions across different samples (using Peptide data).
- Line Chart (icIEF vs Peptide MS)- Comparing % Deamidation of a Specific Peptide at Different Residue Positions vs % Acidic Peak Area: This line chart is used to visualize % deamidation for the same peptide at different residue positions and their relationship with % acidic peak area coming from an icIEF analysis of the same sample.
- Bar Chart - Comparing % Deamidation of a Specific Peptide at Different Residue Positions vs % Acidic Peak Area: The same comparison as the above Visualization using a bar chart.
- Line Chart - Comparing % Modification of All Modified Peptides at Different Residue Positions vs % Acidic Peak Area: This line chart compares % modification (not limited to deamidation) for the same peptide at different residue positions to the % acidic peak from an icIEF analysis of the same sample.
- Pivot Table - Intact MS relative Intensity Expected mass: This pivot table shows the Intact relative intensity for expected masses.
- Pivot Table - Intact MS relative Intensity - All masses: This pivot table shows the Intact relative intensity for all masses, including those that are not named.
- Line Chart (icIEF vs Intact MS)- Comparing Relative Levels of Expected Intact Species vs % Acidic Peak Area: This line chart compares relative levels of expected species identified using Intact MS with the % acidic peak area obtained when running icIEF analysis on the same sample.
- Line Chart (icIEF vs Intact MS) - Comparing Relative Levels of Expected Intact Species vs % Basic Peak Area: This line chart compares relative levels of expected species identified using Intact MS with the % basic peak area obtained when running icIEF analysis on the same sample.
- Line chart - (SEC vs Intact MS) LMWS 2 peak vs Intact mass relative intensity: This line chart compares the Intact mass relative intensity obtained using Intact MS to the LMWS peak area obtained when running SEC analysis on the same sample.
- Line chart - (SEC vs Intact MS) LMWS 2 peak area vs Intact mass relative intensity <5%: This line chart compares the Intact mass relative intensity with values under 5% obtained using Intact MS to the LMWS peak area obtained when running SEC analysis on the same sample.
- Bar chart (SEC vs Intact MS) - SEC HMWS 1 peak vs expected Intact mass relative intensity: This bar chart compares the expected Intact mass relative intensity obtained using Intact MS to the HMWS peak obtained when running SEC analysis on the same sample.
- Stacked bar chart (SEC vs Intact MS) - SEC Main peak Relative Levels vs relative normalized levels of Intact Expected Species: This bar chart depicts SEC main peak relative levels vs the normalized levels of Intact Expected Species obtained using Intact MS.
Once the desired template is selected, the Add Resource dialog prompts the user to enter a name and file location for the new Dashboard. The new Dashboard will be populated with settings copied from the template, and from there the user can modify their copy of the template as desired.
Figure 1.4 Add Resource
1.5.2. From Scratch
To create a new Dashboard from scratch, click New Dashboard on the Deep Query Dashboards page.
Figure 1.5 New Dashboard button
On the Dashboard creation screen, the user will be prompted to add a Title to the Dashboard and specify a Location where the Dashboard should be saved.
Figure 1.6 Dashboard creation screen
A red exclamation point symbol specifies that an entry by the user is required to proceed with Dashboard creation.
Figure 1.7 The Title is a required field, as designated by the exclamation point icon
When creating a Title for the Dashboard, the user will be warned if there is already a Dashboard with the same name within the same Folder. The following special characters are allowed in Dashboard titles: , /, :, *, ?, <, >, |, ', and “. A Dashboard title can be no longer than 255 characters.
To choose a location to save the Dashboard, click Browse, which will launch the Dashboard Folder Structure dialog.
Figure 1.8 Dashboard Folder Structure
Select a folder using the checkbox and click Select Folder. The location will update to the selected folder and will be viewable on the Dashboard creation page.
Figure 1.9 New Dashboard Page with Title and Location
The user must also select a Data Source from which data is derived for the Visualizations. A Data Source is the database view that all data for a Dashboard is pulled from. The data pulled from this view will be fed to all Visualizations within the Dashboard, although there are options to filter Globally or per Visualization once the Dashboard has been established. The Data Source cannot be changed once in the Dashboard Editor.
Figure 1.10 Data Source selection
Currently data from the following Project types is supported by Deep Query: Peptide Analysis, Oligonucleotide Analysis, Chromatogram Analysis, and Intact Analysis. Project data from Oligo, HRIM, Intabio, Supernovo, or HDX is not yet supported. The Combined Analysis data source includes data from both Intact and Peptide projects. The Biophysical Analysis data source includes data from both Intact and Peptide projects as well as Biophysical projects processed through Chromatogram analysis in Byos. Note that queries can only be made in the Biophysical analysis data source against Biophysical data and Intact and Peptide projects cannot be queried together. More information about the Biophysical data source can be found in the Biophysical Data section. Please contact support@proteinmetrics.com for additional help in configuring Dashboards using the Biophysical data source.
Note: Data in Custom columns from Peptide projects have the field name “MS Custom Columns” and data from Intact/Chromatography projects have the field name “Samples Custom Fields”.
Once a data source has been selected, the Dashboard can be created by clicking Create Dashboard. The user will be notified that the Dashboard has been saved and the Dashboard will open in View mode.
Figure 1.11 Icons available in View mode.
To enter Edit mode, where the user can add and update Visualizations within the Dashboard, the user must click Edit.
Duplicate will open a dialog prompting the user to provide a name and location for a copy of the Dashboard to be created. The new Dashboard will be opened upon creation. Note: Duplicating a Dashboard will not duplicate any associated Background Alerts of the original Dashboard. For more on Background Alerts, see Background Alerts .
Figure 1.12 Duplicate Dashboard
Cancel takes the user away from the Edit mode of the Dashboard. From there, the user can click Close to close out the Dashboard currently being viewed. This takes the user back to the page they were on previously before launching the Dashboard creation (e.g., the Home page, Search Result page, File Browser, or File History page).
Once in Edit Mode, the user has the following options available:
Figure 1.13 Dashboard options
Publish will save the Dashboard and publish it to the designated Location that the user has provided. Add New Visualization populates the Dashboard with a new, empty Visualization. Cancel sends the user back to the Dashboard start page, discarding any changes that have been made to the Visualization since it was last published or creation.
1.5.3. Global Filters
Additionally, the user can apply Global Filters. Global Filters are filters that are applied to all data from the Data source present in all Visualizations within a Dashboard. Users are highly encouraged to use Global Filters, as extra-large data sets can increase processing time and may limit the analysis.
Figure 1.14 When a query is too large, the user is notified and encouraged to use filters
The Global Filters dialog can be opened by clicking the icon next to the Data Source.
Figure 1.15 Open Global Filters
To add a filter within the Global Filters dialog, click Add condition.
Figure 1.16 Global Filters dialog
The user can view, add, update, or remove “Include/Exclude” filters that are part of the Global Filter when in Edit mode. When the user applies changes to the global filter, all Visualizations within the Dashboard are refreshed and correctly adjust their display with the newly filtered data.
Figure 1.17 Global Filters dialog with added filter condition
In the above example, the user includes all data that satisfies the condition of containing “NIST” within the value for the Metadata field “File Name”. Only data that meet this condition will be included in the entire Dashboard.
When the user applies changes to a Global Filter, all Visualizations in the Dashboard are refreshed and correctly adjust their display with the newly filtered data.
Filter conditions offer operations specific to the type of value for the selected field:
| Value Type | Operations available |
|---|---|
| String | =, !=, contains, does not contain, begins with, ends with, is null, is not null |
| Number | >, <, =, !=, between, null, not null |
| Date | >, <, >=, <=, between, null, not null |
| All | Null/Not Null |
Filter Conditions
Users have the option to define groups of multiple conditions. For example:
Figure 1.18 Global Filters use case
In the above use case, the user has chosen to include results that satisfy both of the outlined conditions; the File Name must contain the string “NIST” and the Created By value must = “Morgan”.
Alternatively, if the user specifies “Any” in their group, only one of the conditions outlined must be met in order for the data to be included in the query .
Note: All/Any is equivalent to AND/OR as seen in the filters present in Byosphere Web Client search utility.
1.5.4. Add New Visualization
A new Dashboard (not created from a template) will be blank until a Visualization is added. To add a Visualization, click Add New Visualization. This will add a generic Visualization pane to the Dashboard.
Figure 1.19 Adding a Visualization
Users are reminded that the data included in a Dashboard is based upon their permissions. Users will only see data from Projects that are in folders they have privileges to view.
To Duplicate a Visualization, click while the Dashboard is in Edit mode. The duplicated Visualization will contain the same content as the original Visualization, including all filter settings, derived fields, and chart/pivot table settings. Note: Background Alerts will be excluded. When the user makes changes to this copy, the original remains unchanged. The duplicate Visualization will only be saved to the Dashboard if the user publishes the Dashboard.
Figure 1.20 Duplicating a Visualization
To Edit Visualization, click the Edit icon. There are four main panes within a Visualization: the sidebar, which contains settings based upon user selection, the Visualization Builder, the Visualization itself, and Data Preview.
Users can drag the separation between the each of these panes to resize each section.
Figure 1.21 Adjust the size of the Visualization window
The sidebar contains settings that the user can modify and Apply to update the Visualization and Data Preview windows. The settings available in the sidebar for each Visualization type are detailed below. The options available in the sidebar are controlled by the Visualization Builder present at the top of the Visualization Editor page. This flowchart contains two blocks by default representing the fundamental settings available in the Visualization: Data and Display settings. These blocks cannot be removed from the flowchart.
Figure 1.22 Visualization Builder
Clicking on a block will highlight it in the flowchart and populate the sidebar with relevant controls. Shown below is the Data block highlighted with data settings present in the left sidebar:
Figure 1.23 Data settings selected from Visualization Builder
Figure 1.24 Display settings selected from Visualization Builder
The Data Preview pane provides the user with a data grid containing the underlying data being used to generate the Visualization. Updates to the Data Preview occur in sync with any updates made to the Visualization itself, excluding any numerical display changes applied to the Visualization (since these only affect the visualization of the data rather than the underlying values themselves).
A red exclamation point present within the Visualization settings indicate fields that are required to be defined for or removed from the Visualization. To view all issues with the Visualization at once, the user can click the red exclamation point icon in the corner, which will launch the Issues dialog.
Figure 1.25 Issues dialog
Potential issues that could arise in the Visualization include not adding a title, forgetting an essential field or aggregation, or the presence of an unsupported field in a project uploaded from a Visualization created in a previous release version.
The user must provide a unique title for the Visualization. If the user tries to provide a title that is already in use, they will be notified that the title is already in use and will be unable to save the Visualization until a unique title is provided.
Figure 1.26 Please provide a unique title
Once any changes have been made to the settings, the user will be prompted with a dialog in the Visualization pane which, if clicked, will update the Visualization/Data Preview with any changes made.
The refresh button can also be clicked to push a refresh to the Visualization/Data Preview at any time. Clicking Save and Close will refresh the Visualization/Data Preview one final time and save all changes before going back to the Dashboard. Clicking Cancel when in Edit mode will take the user back to the Dashboard, canceling any changes that were made/applied.
1.6. Selecting a Visualization
From Display Settings, users can select their Visualization. Select Visualization Type allows the user to choose a type of data representation to show in the Visualization. The value can be selected from the dropdown or searched by the user to narrow the displayed options. The selected Visualization Type will determine the modifiable values available in the tabs present under Display settings.
Figure 1.27 Select Visualization Type dropdown
Types of Visualization:
| Visualization | |
|---|---|
| Bar Chart | |
| Data Grid | |
| Gauge | |
| Line Chart | |
| Pie Chart | |
| Scatter Plot | |
| Pivot Table | |
| Stacked Bar Chart |
Types of Visualization
1.6.1. Unsupported Fields
If a Visualization created in a previous version of Byosphere and uploaded to the latest release contains any currently unsupported fields, a red box will show up around the box and a warning dialog will indicate that the unsupported data fields need to be removed to proceed with the Visualization to show queried results. Once these are removed, the user can proceed with their Dashboard as normal.
If there is a Global Filter applied that contains an unsupported field, all Visualizations will show the following error card and will not render until the Global Filter has been replaced or removed.
Figure 1.28 Unsupported fields error card
Once all unsupported fields have been removed, click the Refresh button to ensure that changes have been processed.
Note: The majority of these unsupported fields are planned to be reintroduced in later releases.
1.6.2. Line Charts and Scatter Plots
Users can select from either Line Charts or Scatter Plots. The basic Visualization settings for Line Chart and Scatter Plot Visualizations are the same.
1.6.2.1. Basic Data Settings
Figure 1.29 Example of Basic Settings for Line Charts
Group By Fields (X axis): Field(s) to be represented on the X-axis. The user has the option to select multiple fields. Fields can be selected directly from the dropdown, or the user can type within the box to filter through the available fields to find a specific field. Users can select both Data Source Fields and Metadata fields. In this case, the field Data.MS Alias Name has been selected, and the user has the option to search for and add additional fields.
Figure 1.30 Group by Fields (X axis)
- Series: Field to group for separate series in a chart. In the example below, multiple fields have been added to be included in the series grouping.
Figure 1.31 Series field
If multiple fields have been added, they are clustered within the Visualization to represent groups combining values from each field as shown below:
Figure 1.32 Multiple fields grouped into separate series
-
Y Axis Value: Field(s) to be represented on the Y-axis. Requires an aggregation function.
- Aggregation: Available aggregation options will depend upon the data type selected e.g., Data.Apex Posit time has all aggregations available, while Data.Modifications Name List is only a string field and only has count available.
| Data Type | Available Aggregations |
|---|---|
| Numeric | Average, count, max, min, standard deviation, standard deviation (Pop), standard deviation(Sample), sum, variance, variance (Pop), variance (Sample) |
| String | Count |
| Date | Count, max, min |
Aggregation Types
X-axis and Y-axis labels are automatically populated within the Visualization once a field has been selected and applied. If the field(s) is (are) removed and another added, the user will have to manually update the X-axis or Y-axis label values under the Group By Axis and Value Axis tabs.
Note: If you start by selecting an aggregation function, your data fields will be filtered based upon the selected function; for instance, if you select a numeric aggregation e.g., average, text fields such as “Sample name” will not appear.
- Display as relative to/Groups to normalize on: These settings support the following normalization calculations:
- Min (where min is 100%)
- Max (where max is 100%)
- Sum (where sum is 100%)
Options for Groups to Normalize By include:
- Series
- Group By
Note that these settings only pertain to Line Charts, Bar Charts, and Scatter Plots (excluding Stacked Bar Charts).
- Error Bars: Error bar values can be added for Min/Max, Std. Dev, 2 Std. Dev, and 3 Std. Dev. All values are + or - of the aggregation selected, with the exception of min/max. When a user selects a +/- Min/Max the error bar will function as a range (low value is the min and the highest value is the max). If Variance is used as the aggregation error bars will not be present. Note that SDTEV.P and VAR.P are used when determining error values.
Figure 1.33 Error bar settings under Y Axis Value
1.6.2.2. Basic Display Settings
As of release v5.10, users are directed to Select Visualization Type within the basic Display settings. In addition, the fields used to build the Visualization itself, including Group By Fields, Series, and Y Axis value, are all specified within the Display settings. Available fields are based upon the fields selected within the Data Settings.
Users can also error bars within the Display settings for Line Charts.
1.6.2.3. Additional Display Settings
1.6.2.3.1. General
Figure 1.34 General tab
The General tab under the Display Settings enables the user to make modifications to the chart. The user can add a subtitle to any kind of chart and adjust its size/alignment accordingly. If Display Tooltip is enabled, hovering over a data point will show a popup of its value with the format and precision determined by the user (e.g., hundredths place, thousandths place, percentage).
All non-table Visualizations (e.g., Line Charts, Gauges, Scatter Plots) have options under the General Display tab to adjust the margins of the Visualization.
Figure 1.35 Margin settings
Increasing the value of the Margin for each direction will increase the space on that side (e.g., increasing the Left Margin will create more space between the edge of the Visualization itself (for instance, the tick marks) and the Visualization settings panel.
If Auto Expand Margin is toggled on, the dimensions of the Visualization will automatically adjust so that any tick labels are not cut off.
1.6.2.3.2. Legend
The Legend tab enables the user to add a Legend to their chart and configure its position and visibility.
Figure 1.36 Legend tab
1.6.2.3.3. Group By Axis
The Group By Axis tab provides options for modifying the x-axis label and positioning.
Figure 1.37 Group By Axis
1.6.2.3.4. Advanced X Tickets Control
The Advanced X Ticks Control tab provides several tools that can be used to refine the readability of the labels on the x-axis.
Figure 1.38 Advanced X Tickes Control
1.6.2.3.5. Value Axis
The Value Axis tab provides options for modifying the position of and the values and labels shown on the y-axis.
1.6.2.3.6. Constant Lines
The Constant Lines tab allows the user to modify the color, style, size, and value for any constant lines added to the chart. Constant lines can be added by clicking Add and deleted by clicking the blue trash can icon at the top of the window.
Figure 1.39 Constant Lines tab
1.6.2.3.7. Zoom and Pan
Allow Mouse Wheel, if checked, enables the use of the mouse wheel to zoom in and out when the mouse is hovering over the Visualization.
Figure 1.40 Zoom and Pan tab
1.6.2.3.8. Error Values
The Error Values tab provides users with options to modify the characteristics of the error bar, if one is present. Error bars are added within the basic settings. Note: Error Values do not apply to Stacked Bar Charts.
Figure 1.41 Error Values tab
1.6.3. Bar Charts and Stacked Bar Charts
Users can select from either Bar Charts or Stacked Bar Charts. The basic Visualization settings for all Bar Chart Visualizations are the same (excluding Error Bars, which are not present for Stacked Bar Charts).
1.6.3.1. Basic Data and Display Settings
Basic Data and Display Settings are the same for both Line Charts and Bar Charts. See Basic Data Settings and Basic Display Settings above for more information. Any exceptions have been outlined below.
Within the General settings, Error Bars do not apply to Stacked Bar Charts.
Note that if a Chart-type Visualization is created (including Line Charts and Scatter Plots) and then switched to another Chart-type Visualization, all applicable settings should remain in place.
1.6.3.2. Display Settings
Refer to Display Settings for Line Charts and Scatter Plots as the settings for Bar Charts are the same, with two exceptions. Under Display > General for Bar Charts, Bar Normalization provides the ability to normalize values based upon each group-by value, with the following options: Fraction, Percent, or None (default).
Figure 1.43 Bar Normalization
There is one additional tab available under Display Settings for Bar Charts called Series. The Series tab (applicable to the Bar Chart and Stacked Bar Chart only) provides options for highlighting series elements.
Note: Color and opacity options do not apply to Stacked Bar Charts.
Figure 1.44 Series tab
1.6.4. Pivot Tables
1.6.4.1. Basic Data Settings
Figure 1.45 Basic Data Settings
- Data Fields: Select data fields which can be added to the Visualization and configured within the Display settings
- Aggregation: Numeric value to aggregate and display as value
1.6.4.2. Basic Display Settings
As of release v5.10, users are directed to Select Visualization Type within the basic Display settings. In addition, the fields used to build the Visualization itself, including the rows, columns, and data aggregated and displayed within the Pivot Table, are specified within the Basic Display Settings. Available fields are based upon the fields selected within the Data Settings.
1.6.4.3. Additional Display Settings
1.6.4.3.1. General
Figure 1.46 General Display Settings for Pivot Table Visualizations
The General tab under the Display tab provides the user with the ability to modify their view of the pivot table, including adding row and column totals and designating the value provided when there is a blank cell.
Allow Filtering provides the user with a filter search within each column of the pivot table. Typing in a value will filter the results in that column to include only cells that meet the query.
Figure 1.47 Narrowing results with filtering
Display in Empty Header Cells will provide a user-entered value in the place of a blank cell when there is no data in the cell. The default value is <NO VALUE>.
1.6.4.3.2. Field Panel
Figure 1.48 Field Panel Tab in Pivot Table Visualization
The Field Panel tab toggles visibility of the Field Panel as well as data fields and row/column fields (which appear in the Field Panel). Field panels visibility is enabled by default.
Figure 1.49 The Field Panel, showing all Fields
1.6.5. Data Grids
1.6.5.1. Basic Data Settings
Figure 1.50 Basic Data Settings for Data Grid Visualizations
- Data Fields: Data fields that can be selected in Display Settings to be included in the Data Grid
-
Aggregations:
- Aggregation: Numeric value to aggregate and display as value
- Error bar: Error bar values can be added for Min/Max, Std. Dev, 2 Std. Dev, and 3 Std. Dev. All values are + or - of the aggregation selected, with the exception of min/max. When a user selects a +/- Min/Max the error bar will function as a range (low value is the min and the highest value is the max). If Variance is used as the aggregation error bars will not be present. Note that SDTEV.P and VAR.P are used when determining error values.
1.6.5.2. Basic Display Settings
As of release v5.10, users are directed to Select Visualization Type within the basic Display setting. For Data Grid visualizations, users only need to specify a list of fields to add to the Data Grid. Available fields are based upon the fields selected within the Data Settings.
1.6.5.3. Additional Display Settings
1.6.5.3.1. Columns
Columns can be frozen to the left and right sides of a Data Grid Visualization, selectable from the show/hide fields under the Column Display Settings tab. Only the columns present in the Visualization will be listed in the dropdown. Selecting the same column for both sides will result in the column being frozen to the left side.
1.6.5.3.2. Paging
Figure 1.51 Paging Tab for Data Grid Visualization
Within the Paging tab the user can designate the number of rows to be included on each page of
the Data Grid. Position dictates where the page selector is within the Grid (can be on the left or right side). The user can also choose to display the page selector at the top of the Data Grid.
Within the Data Grid, the user can search all records present within the table. The search utility can be found at the top of the grid.
1.6.6. Gauges
1.6.6.1. Basic Data Settings
Figure 1.52 Basic Data Settings for the Gauge Visualization
- Data Fields: Data fields that can be selected in the Display Settings to be included in the Gauge Visualization
-
Aggregations:
- Aggregation: Numeric value to aggregate and display as value
1.6.6.2. Basic Display Settings
As of release v5.10, users are directed to Select Visualization Type within the basic Display settings. In addition, users need to specify the Y Axis value to be used in the Gauge. Available fields are based upon the fields selected within the Data Settings.
1.6.6.3. Additional Display Settings
1.6.6.3.1. General
Figure 1.53 General Settings for Gauge (Circular) Visualization
The General tab under Display allows the user to add a subtitle to the Visualization and adjust its alignment in relation to the Gauge.
The user can also determine how the gauge value is indicated with the Value Indicator option, which allows the user to choose either a needle indicator or a Marker. This number can be shown above or below the number on the gauge.
See Margin Settings for details about Margin controls.
1.6.6.3.2. Ticks
Figure 1.54 Tick Settings for Gauge Visualization
The Tick settings set the starting and ending value of the entire gauge, as well as the tick interval, tick color, tick length, and other characteristics.
1.6.6.3.3. Number
The Number settings set the color and size of the font for the indicator number positioned in the center of the gauge.
1.6.6.3.4. Range Container
Figure 1.55 Range Container Settings for Gauge Visualization
The Range Container tab allows the user to establish one or more “containers” that encompass a specific range on the gauge. For example, a user might want to create a container that encompasses the acceptable range for a value, with the Start Value representing the lowest acceptable value and the End value representing the highest acceptable value. Each range container can be distinguished by setting its Color.
To add an additional range container, click . An additional range container’s values can then be defined. Range containers can be deleted by clicking the trash
icon to the right of each container’s respective header.
Example:
Figure 1.56 Range Containers within a Gauge Visualization
In the above graphic, for the green range container, the Start Value = -2 and the End Value = 2. Two additional range containers were made representing the values -10 to -2.0 and 2.0 to 10 in the color red.
1.6.7. Pie Charts
1.6.7.1. Basic Data Settings
- Data Fields: Data fields that can be selected in Display Settings to be included in the Pie Chart
-
Aggregation:
- Aggregation: Numeric value to aggregate and display as value
- Error bar: Error bar values can be added for Min/Max, Std. Dev, 2 Std. Dev, and 3 Std. Dev. All values are + or - of the aggregation selected, with the exception of min/max. When a user selects a +/- Min/Max the error bar will function as a range (low value is the min and the highest value is the max). If Variance is used as the aggregation error bars will not be present. Note that SDTEV.P and VAR.P are used when determining error values.
Note: Manually zooming in and out of the Visualization using ctrl + mouse wheel may cause rendering issues with the Visualization. If this occurs, clicking Apply should reset the Visualization.
1.6.7.2. Basic Display Settings
As of release v5.10, users are directed to Select Visualization Type within the basic Display settings. In addition, the fields used to build the Visualization itself are added here, including the labels used for different categories with a single pie chart, the numerical to aggregate for chart categories, and Series specification for the generation of multiple pie charts within a single Visualization.
1.6.7.3. Additional Display Settings
1.6.7.3.1. General
The General tab allows the user to add a subtitle to their Pie Chart and adjust its alignment, add and modify tooltips, and adjust the margins of the Visualization (see Margin Settings ).
1.6.7.3.2. Internal Annotations
Internal Annotations options are unique to Pie Charts and, if toggled on, provide information relating to each slice within the Pie Chart. Display mode specifies where the annotation contents are shown. Options include Auto, Horizontal, Radial, and Tangential. Annotation Contents can include the data label, the value of the slice, and the percentage of the whole each slice composes, and users also have the option to include any combination of the three (e.g., Value + Percentage, Label + Value + Percentage).
1.6.7.3.3. Legend
Legend controls are the same as those used for Chart-type Visualizations, see Legend .
1.6.7.3.4. Chart Groupings
The Chart Groupings tab allows the user to combine multiple fields into one section of the pie chart. For example, this chart grouping contains all data fields that begin with “AD001”. Rather than displaying these data fields as independent slices, their values have been combined into a single magenta slice.
1.6.8. Data Settings for all Visualizations
The following settings are available as tabs for all Visualization types and can be accessed by clicking on the Data block within the Visualization Builder.
Figure 1.57 Data Settings
1.6.8.1. Global Filters
Global Filters are data filter settings that are applied across all Visualizations. Data from the selected Data Source will be filtered by these global settings before being passed to the Visualizations. Users can only view any Global Filters that have been applied, as the option to edit has been grayed out. For more information on applying Global Filters, see Global Filters .
Figure 1.58 Global Filters tab, with options grayed out
1.6.8.2. Visualization Filters
Users can add or edit filters within a single Visualization by clicking the Visualization filters tab.
The user can also apply filters to specific Visualizations from the Dashboard by clicking the Filter button in the header of a Visualization. This will open the same Visualization Filters page as seen in the Filter&Sort tab when editing a Visualization.
Figure 1.59 Manage Visualization Filters from the Dashboard
To define a new filtering condition using either filter option, click Add Condition. This will generate a row wherein you can determine which field should be filtered (from within a dropdown), the condition it must satisfy, and a user-entered value. The user is given the option to Include or Exclude results that satisfy either All or Any specified conditions (provided more than one filter has been applied).
Include/Exclude Filters provides filtering of the data that is to be included or excluded in the calculations involved in the analysis; Show/Hide Filters provides filtering of the data that is to be shown in the analysis. If data is hidden based upon defined conditions in the Show/Hide Filters option, it will still be used to make calculations, but it will not be visualized.
Figure 1.60 Include/Exclude Filters
Figure 1.61 Show/Hide Filters
The user also has the option to create multiple conditions within a Group.
Figure 1.62 Multiple Conditions added to a group
The user must ensure that a filter is defined with a value if it is added and that it is not left blank. If the filter is no longer needed, the user can remove the filter by clicking the x next to the row of interest.
In the above example, the group must “Include results that satisfy All of the following [conditions]”. In this case, if three different conditions are defined, they must all be met by a data point for it to be included in the Visualization.
To delete a group of condition(s), click Delete group.
The Filters icon on a Visualization will show the number of conditions applied. The Visualization below currently has two filters applied.
Figure 1.63 Visualization with two filters applied
After performing a Deep Query search and generating a specific plot, the user can apply filters to an attribute of the data from the Visualization and use these filters to do the following:
-
Include/Exclude specific attributes (If Excluded, data is neither considered in calculations nor included in the Visualization).
- Show/Hide specific attributes: In this case, query results are filtered out from the Visualization, but this data is still used to perform the visualized calculations.
Additionally, the user can perform a combination of Include/Exclude and Show/Hide filters.
It is possible for too many filters to be applied or the conditions for the filters to be too narrow, which can result in the warning shown below. In this case, the user will need to try removing filters or adjust conditions (such as Any/All) to ensure that data has not been completely filtered out.
1.6.8.3. Sort
Sort orders data according to sort rules determined by the user.
Users can also order filtered data within a Visualization using the Sort function.
Figure 1.64 Sort Tab
A new Sort rule can be added to the Visualization by selecting a field from the dropdown. Multiple sort rules can be added at a time. Data fields can be sorted by ascending or descending order (selected by clicking on the ASC/DSC button to the right of the field name).
1.6.8.4. Metadata field parsing
Users can parse individual fields from “Data.Samples Custom Fields” to use in querying, filtering, visualization, and calculations. A plus sign icon displayed next to this field indicates the ability to parse.
Clicking on this icon will open a dialog box. Within this dialog box, users can designate the property (the metadata value to parse out, based on which are available in the field) and type (Text, Date, Numeric).
The following example shows the mapping between parsed fields and fields available within Data.Samples Custom Fields and their subsequent parsing as individual fields as the last two columns in the table.
Once a field has been created, it will remain present as a field option in the dropdown for that Visualization.
1.6.8.5. Field aggregations
When applicable, users can select an aggregation type for a specific numerical list field. Aggregation options include Min, Max, Average, and Sum.
Once an aggregation is selected, it is listed next to the field in brackets.
1.6.8.6. Calculation Presets
The Calculation Presets tab provides the user with the ability to build calculated fields based upon Calculation Type.
When a user creates and opens a new Visualization, they will have the option to add a new Calculation Preset.
Figure 87: Normalization Calculation Preset options
The user will be prompted to provide a preset option from the Calculation Type dropdown list. Currently, users can use this tool to build a custom normalized field.
The inputs available are dependent upon the Calculation Type selected. The user will be required to enter values for each field. Users can consult the tooltips for more information on how to populate each field.
The Normalization Total to 100% calculation type provides a template for normalization calculations, which involve dividing a value across the aggregation of that value across a defined window/partition.
Advanced SQL code used to build the preset is updated in real time and can be viewed by the user underneath the Advanced option. Users can click the copy button in the corner to copy the SQL code to the clipboard.
Figure 88: Advanced options can be used to preview SQL code
Some templates contain Visualizations that include calculation presets by default. For example, the Stacked Bar Chart Glycan Distribution Visualization in the PTM template contains the Relative Glycan Quant preset.
Figure 86: Relative Glycan Quant preset
The resultant Relative Glycan Quant field is used to build the Visualization provided.
1.6.8.7. Derived Fields
Derived Fields are variables that are created from one or more existing data fields that exist in a single data source or across data sources. User-created Derived Fields can be used in local Filters, as x or y-axis Values within Visualizations, or within Background Alerts.
Figure 97:Derived Fields Tab
The SQL field names dropdown contains a searchable list of fields and their associated SQL name. Double-clicking the field of interest will populate the SQL text box.
Figure 1.65 Searching SQL fields
Alternatively, the user can manually enter a SQL field into the text box themselves if an applicable field is known.
There are only certain functions available to users. If a user types in a function that does not exist, they are met with a warning:
Figure 1.66 Invalid SQL function entry
Additionally, if a user specifies a number outside of the allowed number of arguments they are warned :
Figure 1.67 Invalid SQL function (too many arguments)
Label denotes the name of the generated derived field. The user can change the Label for any derived field. The user can also provide an optional Description.
The Data Type dropdown enables the user to specify the expected data type they wish to generate using SQL commands, with the options of Date, Numeric, and Text (which includes alphanumeric values). The default data type is numeric.
Once all required fields are filled in, clicking Create will add the user-created derived field to the Visualization (as an option under the X and Y-field dropdowns)
Figure 1.68 Created Derived Field
Once the derived field is created, it can be found within the available Data Fields within Data Settings and can be added to become available in Display Settings.
Figure 1.69 User-Created Derived Field available in Visualization Settings
If the user wishes to make changes to a Derived Field they created, they can click the Derived Field of interest and either Update to make changes or Revert, which will undo the last change that was made after clicking Update.
To create another Derived Field, click Add new Derived Field. Users can create multiple Derived Fields.
1.6.8.8. Background Alerts
Backgrounds alerts can be set up in Deep Query that will notify the user if a value has fulfilled a condition (e.g., Obs > 5) previously assigned. To add a background alert, click . Background alert filters operate on top of the Global, Include/Exclude, and Show/Hide filters associated with the Visualization.
Figure 1.70 Background Alert
The user must provide a name to the alert and has the option to add a description. To assign a condition that must be fulfilled to trigger the background alert, click Add Condition.
Figure 1.71 Example alert condition
In this example, an alert will be triggered for data that satisfies the following condition: For the field “Data.Mass Err PPM”, the value must exceed the value of 20. Users can use both Data Source fields and Derived Fields when building conditions for Background Alerts.
Figure 1.72 Activity and Alert Frequency
Alerts will not incorporate documents that the user does not have access to, and users lacking the correct roles (Contributor or Advanced Viewer) do not have permission to create a background alert.
A Background Alert can be set to Active or Inactive, as shown in the above figure. If an alert is set to Inactive, the alert will not be run at all.
The user can also define how frequently an alert is sent out if conditions are met for a Background Alert. If Daily, the user will receive an alert at 0:00 in their own time zone if the alert conditions have been met within a 24 hour period. If Hourly, the user will receive an alert every hour if the alert conditions have been met. Alerts will only notify a user if new data has been added since the alert was last run. For example, a daily alert run yesterday will only trigger for data that has been added since the previous alert that also meets the specified alert criteria.
The user can create multiple Groups of conditions for an alert filter. This enables the user to set up alerts that are triggered by results that satisfy any of the conditions listed in the group, rather than just one criterion. Multiple conditions can be created per group and multiple groups per designated alert.
Note: Alerts will not be fully saved unless changes are published to the Dashboard.
A message will be sent to the user’s email if the alert is triggered. The user will also receive a notification within the web client.
To delete an alert, the user can click the red x icon on the Alert title.
Figure 1.73 Deleting an Alert
If the user has not saved the alert yet, they will be prompted with a warning dialog.
Figure 1.74 Unsaved alert deletion dialog
Once an alert has been saved, the user will receive a dialog warning that they are about to delete an existing alert.
If an alert in a project created in v5.0 contains an unsupported field or has any other issues, the user will receive an email with a link to the affected Dashboard and the background alert will be disabled.
Currently, there can only be one alert per Visualization at a time.
If the user is not the owner of a Background Alert, they are only capable of deleting it if they delete the Dashboard or Visualization it is tied to. All alerts tied to a Visualization/Dashboard are deleted when the Visualization/Dashboard is deleted. These alerts cannot be recovered even if the Visualization/Dashboard is restored. Any alert without a valid Visualization or Dashboard will be deleted automatically if it is run.
1.6.8.9. Transformations
If a user has selected either a Data Grid or Pivot Table Visualization, a plus sign icon will appear within the Visualization Builder. Clicking on this shows a list of Transformations which the user can apply to their data.
Once a Transformation has been added, it will be visible within the Visualization Builder.
Users can choose from Normalization, Ranking, Filter, Aggregate and Reduce, and Grouped Aggregate options. Each option has its own information that the user must populate. To perform a transformation on data, that data field must be included in the Visualization. Numeric derived fields will also be available. The way in which a grouping occurs for a transformation may be controlled by the user by utilizing the partitioning function, in much the same way as can be performed for the function “Normalization within Calculation Presets” under the Data Settings tab. The types of Transformation possible are outlined below:
-
Grouped Aggregate: This transformation will allow a user to customize a group of data and apply an aggregation to that group. In the example below, if a user wished to sum the data field “Intensity” of each Delta Mass per Protein Name (within each Sample Name), they could select the aggregation type “Sum” and determine grouping by defining the fields to partition by Sample Name and Protein Name. For transformations, only data/meta data fields present in the Visualization may be used.
The figure below shows the original Pivot Table displaying the intensity of each Delta Mass:
Figure 1.75 Before Transformation
The figure below outlines the details of the Grouped Aggregate Transformation being applied. The Transformation sums the intensities within each protein name group (which is also partitioned by Sample Name):
Figure 1.76 Detailed Grouped Aggregate Sum Transformation
The figure below shows the result of the above Transformation settings:
Figure 1.77 Resultant Visualization from the above Transformation
- Aggregate and Reduce: This transformation allows the user to apply a grouped aggregation in the same way as the Grouped Aggregate function, but will also reduce the data by collapsing the data field that is aggregated into a single cell (in the example below, into one row) so that the aggregated value will only appear once. In cases where multiple data fields are partitioned (in the example below, it is partitioning against Sample Name and Protein Name), it will include all the non-partitioned field results into the same cell. Here, all the values for Delta Mass Name are displayed in the same cell for each row, while Protein Name is used to partition. The aggregation applied here is the same as previously described in the Grouped Aggregate section above. The main difference between the two transformation functions is that Grouped Aggregate may report the aggregate multiple times, which could potentially impact any further calculations.
Figure 1.78 Example of Aggregate and Reduce Transformation
Figure 1.79 Resultant Visualization after applying above Transformation
- Ranking: This transformation allows the user to rank numeric values within the tables. There is an option to assign the value of 1 to correspond to the highest value (Ascending Order) vs 1 to represent the lowest numeric value (Descending Order). It is possible to choose which values to partition the ranking over. In the example below, the Ranking partitioning is based upon the data fields Sample Name and Protein Name. In this case the Ranking is based upon the numeric values within each Protein Name, within each Sample. If a user wanted to Rank the entire column, they would only partition by Sample Name.
Figure 1.80 Example of Ranking Transformation
- Normalization: There is an option within Transformations to perform Normalization. This is in addition to the options within Calculation Presets on the Data Settings tab. An option is provided in the Transformations tab so that a user may perform Normalizations on data that has previously been calculated using other Transformation Types. For example, a user may wish to Normalize on data that has previously been aggregated within certain groupings using either the Grouped Aggregate or Aggregate and Reduce transformation. In the figure below, there is a Normalization to the highest numeric value, and all other Normalized values are calculated relative to the highest (Max) value. As the order of operation for the transformations is based upon the sequence order in which they are set up on the transformations tab, this would mean that the Normalization (and hence determination of the highest value to use to Normalize against), is based upon the aggregated value as determined here by the Aggregate and Reduce transformation. In this example, the aggregation (summing) was applied by summing the intensity values within each Protein Name Group, per Sample Name (the same example used in the Aggregate and Reduced section above). The Normalization transformation was then applied on the entire column (in this case the partition was only applied to Sample Name) after the aggregation step, as this is the order in which they appear on the tab. The same calculated result would be obtained by using the Grouped Aggregate Transformation, however, the value itself will be repeated within the cells within the group that is aggregated. For this particular Normalization type, the calculated value would not be impacted, however, for the Normalization type “Sum” the repeating numeric display would affect the final calculated %. In cases like this, it is recommended to use Aggregate and Reduce.
Figure 1.81 Example of Normalization Transformation
Figure 1.82 Result of Normalization Transformation with no Agg or Reduce
-
Filter: As with Normalization, the Filter function that is available under Data Settings is also available as part of the Transformations, so that it may be applied sequentially within, or after, other transformation calculations. In the following example a user wants to only display the Intensity values for the 3 most intense Delta Masses within each Protein, per Sample Name.
The first operation would be to Rank each of the intensities within each Protein Name Group. This may be carried out as described earlier under the Ranking section. However, in this case, as the user wishes to then add a filter, the Transformation itself must be saved as a Transformation Field, so that it will be available as an option when applying the Filtering Transformation. In this example, the custom Transformation name that was given is “Rank”. When saved as a transformation field, it is only available for further transformation calculations, and not as an option within the Visualization itself.
When the user adds the next Transformation in the order of operations, they are able to select a filter to only display those intensities that were in the top 3 ranked.
Example with ranking applied
The Filter transformation step shown below is then applied after the Ranking transformation.
Note: Unlike Visualization filters, Transformation filters will apply in the sequence that they appear in the transformations. They will act as a filter to anything at a given step at the sequence and won't impact anything before that step. Since transformations happen after the data settings step, the transformations filters apply after the major settings for global, include/exclude, show-hide filters and before any previous transformations have been applied.
1.6.8.10. Advanced Functions
If a user has selected either a Line Chart or Scatter Plot Visualization, an Advanced Function option is available for user selection in the dropdown of the Visualization Builder:
Currently, the only Advanced Function available is Linear Regression. Upon adding the Linear Regression Advanced Function, the user must add the Independent and Dependent Variables from the fields provided in the dropdown.
Adding Linear Regression will calculate the equation for the line of best fit, the Pearson Correlation, and the R2 value. Display of these values within the Visualization can be enabled from General > Display settings.
Figure 1.83 Linear regression display toggle
1.6.9. Visualization Inspection
Users can view the files present within their Dashboard by clicking the Visualization Inspection icon:
Figure 1.84 Visualization Inspection icon
This toggle shows an inspection table where users can view the Folder, Project File, and the Sample file name.
Figure 1.85 Visualization Inspection table
The Folder icon will take the user to the folder browser view, opening a new tab.
The File Search Icon will take the user to the file search view, opening a new tab (if the user has Virtual Client enabled, they can open and review the results in the Project from within Byosphere).
Visualization Inspection views are accessible from Edit mode and the main Dashboard page and are available for all data sources.
1.6.10. Image Export
Users can click the Image Export icon in View or Edit mode to export images of their graphical Visualization (excluding Pivot Table and Data Grid). Images can be exported as PNG, JPEG, or SVG.
1.6.11. Export CSV
Users can export a CSV of the data present in their Pivot Table and Data Grid Visualizations.
1.6.12. Biophysical Data Source
The Biophysical data source, which can be used for data assessment between different orthogonal analyses, is a unique data source in several ways. Data originating from Intact, Peptide, and Chromatogram data sources can all be ingested, provided there is an association that can be made between the MS data and the Biophysical data through the fact that they are results generated for the same samples.
1.6.12.1. Ways to associate data
Mass spectrometry (MS) data must be associated with Biophysical data to be ingested. Data can be associated in one of two ways:
- Sample Names are identical – if the value of Sample Name matches for both sets of data, data will be ingested and correlated in the Biophysical data source (Users can assure this by reviewing and editing the sample name in the Samples Table within the data analysis project)
- A metadata value, sample_code, exists for the Biophysical data (saved with the project at the file level within Byosphere) and can be also found within the Sample Name of the MS data. Example:
-
The Biophysical data file, for instance, a .peaks file (a Byosphere generated file format to include previously exported 3rd party chromatographic software results), has the following metadata value, which was parsed from a .ars report file containing metadata:
-
The MS raw data file, processed within a Byos Intact project, has the following associated sample name within the projects samples table and is corresponding to the same sample run on both instruments:
In this case, the user does not need to alter their sample naming conventions for either sample, which would be undesirable when there are company or laboratory standards of naming. Instead, the user must simply provide an additional metadata value in the Biophysical data that correlates with a unique identifier also present in the established MS sample name.
1.6.12.2. Using the Inspection Tool
Like with all other data sources, users can view the files present within their Biophysical Dashboard by clicking the Visualization Inspection icon. However, due to the complexity of the Biophysical data source, there are additional fields present to accommodate identification of all contributing data points.
| Field | Data Source | Description |
|---|---|---|
| Biophysical Folder | Biophysical | The folder from which the Biophysical data file originates |
| Biophysical File Name | Chromatogram | The file name of the Chromatogram project from which Biophysical data is processed |
| Biophysical Sample Name | Chromatogram | The name of the Biophysical data within the Chromatogram project |
| Chromatogram Sample Name | Biophysical | Sample Name originating from the Biophysical report (.ars) |
| Sample Code | Biophysical | Metadata value originating from Biophysical report (.ars) |
| Peptides Folder | Peptides | The folder from which the Peptides data originates |
| Peptides File Name | Peptides | The file name of the Peptides project from which Peptide MS data is processed |
| Peptides MS Sample Name | Peptides | The name of the Peptides MS sample within the Peptides project |
| Intact Folder | Intact | The folder from which the Intact data originates |
| Intact File Name | Intact | The file name of the Intact project from which Intact MS data is processed |
| Intact MS Sample Name | Intact | The name of the Intact MS sample within the Intact project |
Visualization Inspection fields for Biophysical Data
1.7. Publishing a Dashboard
Clicking Save and Close after changing Visualization settings, adding Filters/Sort, Derived Fields, or Background Alerts will update the Dashboard in real-time for the user. However, this will not save the contents of the Dashboard and any changes will be lost if the page is closed and reopened.
To ensure any changes made to the Dashboard have been saved, the user must Publish the Dashboard by clicking the icon on the right-hand side of the Dashboard. Note that this button only becomes available once the user has clicked
when initially entering the Dashboard.
Note that the Publish button will be disabled if the user tries to change the name of the Dashboard to a preexisting name that is already saved within the same Folder.
If publishing a Dashboard fails for some reason (such as having an invalid or blank Title or Location), the Dashboard will remain in Edit mode so the user can try again. If the Publish is successful, the Dashboard Editor will close, and the Dashboard will display in Viewer mode.
If the user clicks Cancel prior to Publishing a Dashboard that has changes, they will be met with a dialog asking if they would like to proceed and discard any unsaved changes.
Figure 1.86 Discard any unsaved changes dialog
Branch: release/2025.09
Compile Date: 2025-Oct-03
Compile Time: 12:00:53