Table of Contents

guest
2024-03-18
Panorama: A Repository for Targeted Mass Spectrometry Assays from Skyline
Panorama Public
Panorama Partners Program
AutoQC Loader
Documentation
   Release Notes
   Create a Folder in Panorama
   Folder Navigation in Panorama
   Adding Users to a Project
   Import Data Into Panorama
   Adding Links in Wiki Pages
   Panorama Public
     Submit Data to Panorama Public
     Upload Raw Data
     Upload Supplementary Files
     Include Subfolders in a Panorama Public Submission
     Data Validation for ProteomeXchange
     Finding Unimod Matches
     Download Data From Panorama Public
   Quality control with AutoQC
     Lindsay Pino's AutoQC Setup Tutorial
     AutoQC Loader Documentation
       AutoQC Loader 1.1.0.20237 Documentation
     Recovering configurations for a broken installation
   Install Panorama
Tutorials
   Tutorial: Sharing Skyline Documents
   Tutorial: Panorama Chromatogram Libraries
   Tutorial: Submitting Supplementary Data to Panorama Public
Webinars
   System Suitability Best Practices With Skyline & Panorama
   Introduction to Panorama 17.2
   Panorama Public and Panorama AutoQC
   Panorama: An Introduction
   Panorama: Managing and Analyzing Large Datasets
   Panorama Targeted Proteomics Knowledge Base
Publications
Dashboard
Example Data
Related
University of Washington
Archived
   Tutorial: Submitting Supplementary Data to Panorama Public
   Submit Data to Panorama Public

Panorama: A Repository for Targeted Mass Spectrometry Assays from Skyline


Get started with Panorama today. Sign up to request a project on PanoramaWeb. Join the Panorama Partners Program to deploy your own Panorama server.

Browse the Panorama Public repository

Get Started


Panorama was developed with the following goals for targeted proteomics investigation:

  • Help labs aggregate curated results
  • Store the complete Skyline document data model
  • Use previous experiments to inform new experiments
  • Make it easy to search and review a large body of experiments
  • Facilitate sharing results
  • Keep private data secure

Panorama was designed to integrate with existing Skyline workflows.  Users can publish their documents to a Panorama server directly from Skyline.  Data on the server can be organized in folders, and users can take advantage of LabKey Server's fine-grained permission controls to securely share data with collaborators, or make it publicly available.  You can browse through some of the example experiments below to explore the Panorama UI for published Skyline documents. 

PanoramaWeb is a public Panorama server hosted at the University of Washington where laboratories and organizations can own free projects.  You can request a project on this server to find out what Panorama has to offer, without having to set up and maintain your own LabKey Server.  You will be able to explore all the available features in Panorama, and be given administrative rights to your project so that you can set up folders and configure permissions.  The LabKey Server security infrastructure will allow you to keep your data as private as you want or release it publicly when you are ready.

Panorama can also be installed by laboratories and organizations on their own servers.  Look at Install Panorama to get started. 

Events

Skyline User Group Meeting Online before ASMS 2020
Review the presentations

Skyline User Group Meeting at ASMS 2019
Review the presentations

Skyline User Group Meeting at ASMS 2018
Review the presentations

Skyline User Group Meeting at ASMS 2017
Review the presentations

Skyline User Group Meeting at ASMS 2016
Review the presentations

Recently Published

Panorama Public: A public repository for quantitative data sets processed in Skyline Vagisha Sharma, Josh Eckels, Birgit Schilling, Christina Ludwig, Jacob D. Jaffe, Michael J. MacCoss and Brendan MacLean. Molecular and Cellular Proteomics. 2018
[abstract] [pdf]

An Automated Pipeline to Monitor System Performance in Liquid Chromatography Tandem Mass Spectrometry Proteomic Experiments Michael S. Bereman, Joshua Beri, Vagisha Sharma, Cory Nathe, Josh Eckels, Brendan MacLean, Michael J. MacCoss. Journal of Proteome Research. 2016
[abstract] [pdf]

Panorama Public: ProteomeXchange and Cloud Storage Integration. Sharma V, Connolly B, Eckels J, Bradlee D, Omaiye A, MacCoss MJ, MacLean B. ASMS Poster. 2019
[pdf]

Customizable quality control metrics and notifications with Panorama, AutoQC, and Skyline. Eckels J, Sharma V, Pradere M, Juneja A, Omaiye A, Nathe C, Jewargikar S, MacCoss MJ, MacLean B. ASMS Poster. 2019
[pdf]

Audit Logs to enforce document integrity in Skyline and Panorama. Rhode T, Chupalov R, Shulman N, Sharma V, Eckels J, Pratt BS, MacCoss MJ, MacLean B. ASMS Poster. 2019
[pdf]

Managing Small Molecule Targeted Mass Spec Assays using Skyline and Panorama. Eckels J, Sharma V, Pratt B, Dunkley T, Wildsmith K, Anania V, Li Q, Nathe C, Patel B, MacCoss MJ, MacLean B. ASMS Poster. 2016
[pdf]

More Publications



Panorama Public





Panorama Partners Program


Panorama is a freely-available, open-source repository server application for targeted proteomics assays that integrates into a Skyline proteomics workflow. It has been implemented as a module within LabKey Server, an open-source bioinformatics data management platform with extensive support for proteomics data and a security model rich enough to support clinical studies.

The Panorama Partners Program (P3) is designed to help organizations like these make the most of Panorama and its integration with Skyline, host their own in-house installation of the software, and provides a unique opportunity to help guide its development. It gives users a chance to engage directly with the Panorama and Skyline development teams, and help shape the direction of the projects to better suit the organization’s targeted mass spec needs. It has been serving Roche (since 2013), Genentech (since 2013), Merck & Co., Inc. (since 2014), NCI-CPTAC (since 2017) as members, as well as other multi-year pharma partners.

Learn more about the Panorama Partners Program and how it can help your organization.




AutoQC Loader


AutoQC Loader is a utility application that uses SkylineRunner to invoke Skyline without a user interface for automated data processing. AutoQC Loader can be run on an instrument control computer to capture new QC runs automatically, add them to a Skyline document, and upload the document to a Panorama QC folder. Panorama retains a full history of QC run performance, and presents users with interactive plots for key metrics including retention time and peak area. Additionally, users can add information about changes including instrumentation, maintenance, and reagents, which are overlaid on the plots, providing a convenient way to correlate cause and effect.

Install AutoQC Loader for Skyline or Skyline-daily (Note: The most recent versions are recommended, but Skyline 3.5 and later or Skyline-daily 3.1.1.8694 or later are supported.)

Note:You can download and install AutoQC Loader unplugged on computers with issues connecting directly to the internet.

AutoQC Loader Documentation
Panorama QC folder documentation
AutoQC Setup Tutorial


AutoQC Loader Release Notes

AutoQC Loader 22.1.0.122 (May 2nd, 2022)
  • Updated SkylineRunner.exe and SkylineDailyRunner.exe to support ampersand (&) in the Windows username


AutoQC Loader 21.1.0.158 (June 7th, 2021)
  • Added new buttons to
    • Open the Skyline document associated with a configuration
    • Open the Panorama folder associated with a configuration in a web-browser
    • Open the folder that AutoQC Loader is monitoring for raw data
    • Open the folder that contains the AutoQC.log file for a configuration
  • Added a Skyline tab in the AutoQC Configuration form that allows selecting the Skyline installation that should be used for a configuration
  • Configurations can be exported as AutoQC Configuration files (.qcfg). These files can be imported by clicking the Import button and selecting a .qcfg file to import, or by double-clicking the .qcfg file
  • Invalid configurations are displayed in red text, and can be fixed with a wizard-like Configuration Set Up Manager
  • Added a Remove results checkbox. This is checked by default to remove older results and keep the active Skyline document from getting too large. It can be unchecked to keep all the imported results in the Skyline document. (Note: for long running projects this may eventually cause a noticeable slowdown in upload times.)
  • AutoQC.log file is written into a directory with the same name as the name of the configuration. This directory can be found in the directory that contains the template Skyline document
  • Importing raw data into the Skyline document and uploading it to Panorama are now separate commands. If a Panorama upload fails it is retried every 5 minutes until it succeeds or more than 24 hours have elapsed since the last successful upload. The configuration stops with an error if Panorama uploads have not been successful in over 24 hours.
  • Pinging the Panorama server now requires a single request instead of two. The first request was made to get a CSRF token. This is now reused for subsequent ping requests so that only a one http request is made


AutoQC Loader 1.1.0.20237 (Aug 23rd, 2020)
  • This release combines AutoQC Loader and AutoQC Loader-daily into a single installer
  • The Settings tab has additional options to:
  • When AutoQC Loader first start up after this upgrade it will attempt to look for an existing Skyline installation


AutoQC Loader 1.1.0.19128 (May 8th, 2019)
  • Added a Settings tab with 2 checkboxes
    • Keep AutoQC Loader running: This will start AutoQCStarter.exe, a small executable, that checks every couple of minutes to see if AutoQC Loader is running, and starts it if it is not running. Any configurations that had been running when AutoQC Loader was last running are automatically started. A shortcut to AutoQCStarter.exe is placed in the Windows Startup folder so that AutoQC Loader is starts up automatically when the computer restarts
    • Minimize program to Windows System Tray: This will put an icon for the program in the System Tray instead of the Windows Task Bar when the program is minimized


AutoQC Loader 1.1.0.19048 (Feb 18th, 2019)
  • Use TLS 1.2 protocol. PanoramaWeb disabled everything but TLS 1.2


AutoQC Loader 1.1.0.19027 (Jan 27th, 2019)
  • Keep configuration running if watched path is on a network share and becomes unavailable due to temporary network disruptions
  • Change color of "Running" status if watched path (network share or mapped network drive) is unavailable
  • Wait for up to an hour to re-connect to network share before stopping configuration
  • Keep last 100 log messages in memory


AutoQC Loader 1.1.0.18345 (Dec 11th, 2018)
  • Bug fixes:
    • AutoQC Loader was not putting a raw file on the re-import queue if Skyline was unable to save the .sky or .skyd file (e.g. if the document is open in another instance of Skyline) after successfully importing the file
    • A raw file could be put on the re-import queue more than once. Example case: A file backup utility copies raw files from the instrument computer to the computer where AutoQC Loader is running. The file may be copied while it is still being acquired, and will fail to import and be added to the re-import queue. If the file is then added again to the folder by the backup program, before full acquisition, it will fail to import again and be added to the re-import queue a second time


AutoQC Loader 1.1.0.18302 (Nov 1st, 2018)
  • Fixed bug: AutoQC Loader was not listening to file rename events (reported by Vidya)
    • Reported case: backup program copies files from the instrument computer to a mapped network drive. File is renamed when it is fully copied
  • Fixed bug: UNC paths could not be used for the Skyline file or watched folder (reported by Michel)
  • Include CSRF token in all POST requests to a Panorama server



Documentation





Release Notes


Version 23.11, released November 2023

  • Panorama is compatible with the Skyline 23.1 file format beginning with version 23.7.3. (learn more)

LabKey Server General Enhancements

  • The page for managing short URLs uses a standard grid, making it easier to use and faster to load. (docs)
  • Administrators can improve security by selecting a new, stronger, entropy-based password rule. Site administrators of production deployments will now see a warning if they use the "Weak" password option, which will be removed entirely in the next major release. (docs)
  • Individual fields in Lists, Datasets, Sample Types, and Data Classes, can be defined to require that every value in that column of that table must be unique. (docs)
View the full LabKey Server 23.11 release notes.

Version 23.7, released July 2023

  • Use a Calendar View to easily visualize performance and utilization of instruments over time. (docs) Also available in 23.3.6
  • Improved outlier indicators make it easier to see the severity of an issue at a glance. (docs) Also available in 23.3.6
  • Panorama will be compatible with the upcoming Skyline 23.1 file format beginning with version 23.7.3.

LabKey Server General Enhancements

  • Permissions for an existing user can be updated to match those of another user account. (docs)
  • Export a folder archive containing metadata-only by excluding all data. (docs)
  • Administrators can configure the retention time for audit log events. (docs)
View the full LabKey Server 23.7 release notes.

Version 23.3, released March 2023

  • New Panorama MAM report for early-stage post-translational modification (PTM) with improved formatting and layout. (docs)
  • New QC plots let you track the trailing mean and %CV of any QC folder metric over a specified number of runs. (docs) Also available in 22.11.6.
  • An example of using a custom run-scoped metric has been added to the documentation and examples available on PanoramaWeb. Capture and track Peptide ID Count following these steps. (example)

LabKey Server General Enhancements

  • Enhancements have been made to clarify the options of importing new data, updating existing data, and merging both update and new data in the same import. (docs)
  • Administrators are now proactively warned about "unknown modules," modules that were previous installed but no longer exist in the current deployment. Administrators are encouraged to delete these modules and their schemas. (details)
View the full LabKey Server 23.3 release notes.

Version 22.11, released November 2022

Panorama

  • Protein groups (mapping a peptide to multiple possible proteins) will be represented in Panorama folders when a Skyline document. (docs) Also available in version 22.7.2.
  • Performance and plotting improvements for QC folders with many samples. (docs)
  • Support for z+1 and z+2 ions.
  • Amino acid indices within protein sequences are based at 1 (instead of 0) for consistency with Skyline. (docs) Also available in version 22.7.2.

LabKey Server General Enhancements

  • New role available: Editor without Delete. Users with this role can read, insert, and update information but cannot delete it. (docs)
  • Lists can use definitions that are shared across multiple containers, improving the ability to use them for cross-folder data consistency. (docs)
View the full LabKey Server 22.11 release notes.

Version 22.7, released July 2022

Panorama

  • Protein Sequence Coverage maps provide a heatmap style view of peptide intensity and confidence scores. (docs)
  • Include annotations, guide sets, and customized view settings when you export or copy a Panorama QC folder. (docs)
  • Consistency improvements in the interface for excluding/including precursors and viewing grids. (docs)
  • Option to split precursor and transition series on chromatogram plots. (docs)
  • Quick links make it easier to subscribe to per-folder outlier email notifications. (docs)
  • Improved and streamlined QC Plot user interface. (docs) These changes are also available in version 22.3.4.
    • When showing all series in a single plot, hovering over a point highlights the selected series.
    • Points in plots are no longer shown as different shapes; all points are now circles, with excluded data shown as an open circle.
    • Streamlined interface for QC plots, including removal of the small/large option, adjusted spacing for better display, and rearrangement of the plot checkboxes and options.
    • Always include full +/- 3 standard deviation range in QC plots.
  • Support for crosslinked peptides, including improvements in multi-attribute method reporting about how and where peptides are linked. (docs) Also available in version 22.3.6.

LabKey Server General Enhancements

  • Use wiki aliases to redirect legacy links when page names change. (docs)
  • New options to clear all objects and reset default selections on the export folder/study objects page make it easier to select the desired content of a folder or study archive. (docs)
View the full LabKey Server 22.7 release notes.

Version 22.3, released March 2022

Panorama

  • Configure which peptide and small molecule precursors are tracked for system suitability, so that you can focus on the most relevant ones. (docs)
  • Set the default view for QC plots for providing customized and consistent views to users. (docs)
  • Improvements to Reproducibility Report: Select either light/heavy ratio or peak areas. (docs)
  • Performance of AutoQC plots has been improved.

Distribution Changes

Upcoming Distribution Changes

  • Beginning with LabKey Server version 22.4 (April 2022), support for Java 16 will be removed. Before upgrading, Java will need to be upgraded to a supported version of JDK 17.
  • Beginning with version 22.4 (April 2022), support for Microsoft SQL Server 2012 as the primary database for LabKey Server will be removed. Before upgrading, your database will need to be upgraded to a supported version of Microsoft SQL Server.
View the full LabKey Server 22.3 release notes.

Version 21.11, released November 2021

Panorama

  • When viewing a protein or molecule list, multiple peptides and molecules chromatograms are plotted together. (docs)
  • Monitor iRT metrics (slope, intercept, and r-squared correlation) to track system suitability. (docs)
  • Integrate Panorama with LabKey Sample Manager (docs)

Operations/Development

  • Release 21.11 of LabKey Server no longer supports Java version 14 or 15. We recommend upgrading to Java 17 for long term support. (docs)
    • Running under JDK 16 or 17 still requires use of special JVM flags. (docs)
  • Support for PostgreSQL 9.6 has been removed. Before upgrading, PostgreSQL must be upgraded to a supported version.

Upcoming Distribution Changes

View the full LabKey Server 21.11 release notes.

Version 21.7, released July 2021

Panorama

  • Reproducibility Report - Now integrated into chromatogram libraries, assess inter- and intra-day variation based on raw, normalized, or calibrated values, along with calibration curve and figures of merit data. (docs)
  • Improved navigation and summarization for calibration curve and figure of merit reporting. (docs) | (docs)
  • Pressure Traces - In QC folders, use pressure traces as sources for metrics to monitor for system suitability and identify column and other problems. (docs)

Operations/Development

  • Support for PostgreSQL 9.5.x has been removed. Before upgrading, PostgreSQL must be upgraded to a supported version.
  • Support for Apache Tomcat 8.5.x has been deprecated and will be removed in 21.8.0. Please upgrade to Tomcat 9.0.x ASAP. (docs)
  • The build has been updated to use Gradle 7, which now allows building LabKey from source with JDK 16. Running under JDK 16 still requires use of a couple special JVM flags. (docs)
View the full LabKey Server 21.7 release notes.

Version 21.3, released March 2021

Panorama

  • Link from Experiment data to QC folder - Panorama automatically links data in Experiment folders to the QC folder(s) that contain data from the same instrument, making it quick to see how the instrument was performing at the time of acquisition. (docs)
  • Instrument summary on replicate page - Easily see which instruments acquired the data in a Skyline document. (docs)
  • Always include guide set data in QC plots - When zooming in to view QC data for a specific date range, juxtapose the guide set data that's being used to identify outliers. (docs)
  • MxN reproducibility reports - New reporting summarizes intra- and inter-day variability for peptides within a protein to assess its reproducibility. (docs)
  • PDF and PNG plot exports - Many Panorama reports are now rendered as vector-based plots in the web browser for better clarity and offer PDF and PNG export formats. (docs | docs)
  • Reduced memory usage during import - Importing large Skyline documents uses 80% or less memory, offering much better performance and scaling. (docs)
  • Enhanced chromatogram library exports - Chromatogram libraries (.clib files) now include additional optimization and ion mobility information. (docs)

Operations/Development

  • Java 13 No Longer Supported - LabKey has removed support for JDK 13. Before upgrading LabKey Server, Java must be upgraded to a supported version.
  • Upgrade all LabKey Dependencies - We strongly recommend that, as part of your LabKey Server upgrade, you also upgrade all major LabKey dependencies to the latest point releases: AdoptOpenJDK 15 64-bit (x64) with HotSpot JVM, Tomcat 9.0.x, and PostgreSQL 13.x.
  • Upgrade Instructions - Follow the steps in this topic to upgrade to the latest release of LabKey Server: Upgrade Instructions
  • Support for running under the upcoming JDK 16 release is available with use of a special flag. You cannot yet build LabKey from source with JDK 16. Learn more here: docs
  • Microsoft SQL Server (and all other non-PostgreSQL database connections) are supported only in Premium Edition distributions. The BigIron module, which provides support for Microsoft SQL Server, Oracle, MySQL, and SAS/SHARE, has moved to Premium Edition distributions.
View the full LabKey Server 21.3 release notes.

Version 20.11, released November 2020

Panorama

  • Refinements to Multi-attribution Methods Reports - Peptide reporting shows more information of interest. (docs)
  • Small Molecule Chromatogram Libraries - Curate and export chromatogram libraries for small molecules in addition to proteomics data. (docs)
  • Performance improvements for QC metric reporting.
  • Higher resolution plots - Chromatograms and sample comparison plots leverage higher resolution displays when available. (Introduced in 20.11.1)

Operations/Development

  • Completed migration of LabKey source code and history to GitHub. A read-only copy of the trunk code will remain available in subversion to assist in migration, but all new development will be on GitHub. (docs)
  • The developer links menu has been reorganized to better support developer needs. (docs)
  • Upgrade to the Log4j 2 API with release 20.11. A backwards-compatibility JAR will be available if you are not able to upgrade immediately. (docs)
  • Updates to module.properties file handling
  • Security Update: API calls like selectRows and executeSql and UI-based requests that render data grids will now return a 400 error response if the parameters have invalid values. For example, if the maxRows parameter has a non-numeric value. In the past these bogus values were ignored, and the server used the parameter's default.
View the full LabKey Server 20.11 release notes.

Version 20.7, released July 2020

Panorama

  • Panorama QC Performance - Performance improvements when reporting on QC folders with high data volume. (docs)
  • Skyline Audit Log - Improvements to import and display of Skyline document's audit log. (docs)
  • Crosslinked-Peptides - Support for Skyline's new handling of cross-linked peptides.
  • Multi Attribute Method (MAM) Folder Type - Panorama includes a new folder type intended for groups doing MAM analysis, making key reports easily available.

Operations

  • Changes to How JDBC Jars are Distributed - The JDBC jars (jtds.jar, postgresql.jar, mysql.jar) are now versioned and distributed inside the module directories like any other third-party jar, making it unnecessary to copy them to the CATALINA_HOME/lib directory during installation and upgrade. When you upgrade to 20.7, delete these JDBC jar files from CATALINA_HOME/lib to avoid conflicts.
  • Changes to Source Directory Structure - When building from source, the /optionalModules and /externalModules directories are no longer used. Move all contents from these directories into /server/modules. Note that this change only applies to developers building the server from source; for production servers /externalModules can still be used for deploying modules.
  • Changes to How Proteomics Binaries are Distributed - The proteomics binaries are now downloaded automatically without further action. This download can be skipped if desired.
  • Java, Tomcat, and PostgreSQL Versions - LabKey has removed support for JDK 12.x, Tomcat 7.0.x, and PostgreSQL 9.4.x. Before upgrading LabKey Server, we strongly recommend you also upgrade all major LabKey dependencies to their latest point releases. (docs)
  • Upgrade Instructions - Follow the steps in this topic to upgrade to the latest release of LabKey Server: Upgrade LabKey Server
View the full LabKey Server 20.7 release notes.

Version 20.3, released March 2020

  • Month-based Version Names - A new month-based naming pattern has been adopted for LabKey Server. This March 2020 release is named 20.3; the next production release in July 2020 will be 20.7.

Panorama

  • Skyline Document Version Updates - Updates to Panorama to ensure full compatibility with changes to Skyline's file format.
  • Sample File Scoped Chromatograms - Display and provide API access to chromatogram-style data contained within Skyline documents. (docs)
  • Multi Attribute Method (MAM) reporting - To support MAM analysis, Panorama now includes a post-translational modification (PTM) report that shows the percent of peptides that included tracked PTMs across samples, as well as a Peptide ID report that shows the identified peptides with their retention times, and expected and observed masses.

Operations

  • Important Security Update - LabKey Server 20.3 includes an important security update, which has been back-ported to version 19.3.7. We strongly recommend that you upgrade your servers to at least 19.3.7 to pick up this security update.
  • AdoptOpenJDK 13 - Starting with LabKey Server 20.3.0, we recommended AdoptOpenJDK 13 for new installations and upgrades. (docs)
  • Upgrade all LabKey Dependencies - We strongly recommend that, as part of your LabKey Server upgrade, you also upgrade all major LabKey dependencies to their latest point releases, these include: Java, Tomcat, and your database server. (docs)
View the full LabKey Server 20.3 release notes.

Version 19.3, released November 2019

Panorama

  • Panorama Premium: Auto-enabling Metrics - Metrics are shown when relevant data is detected; these metrics are hidden when relevant data is not detected. (docs)
  • Skyline List Support - Lists defined in Skyline are imported and available in Panorama folders. (docs)
  • Isotopologue Metrics - Plot isotopologue metrics including LOD and LOQ when data is available from Skyline. (docs)
  • Total Ion Chromatogram Metric - In QC folders, track the total ion chromatogram area as a metric, scoped to the entire run. (docs)
  • Skyline Audit Log - Import the Skyline audit log into Panorama. (docs)

Version 19.2, released July 2019

Panorama

  • Zip files during upload - .raw and .d directories or raw data files (from Agilent, Waters, and Bruker instruments) are automatically zipped before upload to a Panorama files repository. (docs)
  • Premium Features for Panorama Partners: New features available exclusively to members of the Panorama Partners Program and on PanoramaWeb.org:
    • Panorama Premium: Outlier Notifications - Subscribe to email notifications for new QC folder data imports, or only when the number of outliers in a series of imports is over a threshold. (docs)
    • Panorama Premium: Configure QC Metrics - Configure which QC metrics are used for analysis. (docs)

Operations

  • MS1 Module Removed - The MS1 module has reached end of life and due to lack of usage, has been removed.
  • Internet Explorer - End of Support - LabKey no longer supports Internet Explorer. For details, see supported browsers.
  • Upgrade to Java 12 - Oracle has ended public support for Java 11, and as a result, LabKey has completely removed support for Java 11 in the 19.2.0 release. For details, see supported Java versions.
  • Upgrade Tomcat Version - If you are using Tomcat 7 or 8, be sure to update to the latest point release. LabKey Server version 19.2.0 will be incompatible with Tomcat releases prior to 7.0.76 or 8.5.12. If you are using an incompatible version, you may see JSP compilation errors. Tomcat 9 releases (beginning with 9.0.0) are compatible and will not see these errors. For details, see supported Tomcat versions.

Development

  • Source Code Migration to GitHub - Core LabKey Server modules have been migrated from SVN to GitHub, as well as the central automated test code and all of the modules from server/customModules. (docs | docs)
  • Performance improvements by caching virtual schema metadata - Database schema metadata has always been cached, but beginning with release 19.2.x, table and column metadata for user schemas (i.e., virtual schemas) is also cached per request. This improves performance when processing complex queries.

Version 19.1, released March 2019

Panorama

  • Improved Replicate Views - The replicate view of a Skyline document now highlights the annotations present in that single file, as well as showing more information about the samples being used.
  • QC Folder Optimizations - Page load times for QC folders with substantial amounts of data should be improved.
  • Import Optimizations - The time required to import a Skyline document has been reduced, by 50% or more in many cases.

Security

  • See User and Group Details Role - Allow non-administrators to see email addresses and contact information of other users as well as information about security groups. (docs)
  • Enforce CSRF Checking - All POST requests must include a CSRF token. This is no longer a configurable option. (docs)

Sample Management

  • Sample Set Updates - The sample set creation and import pages have been streamlined and standardized. Performance has been improved when importing large sample sets, as well as for query and update operations. (docs).

Administration

  • Configure Allowable External Redirects - Create a whitelist of allowable redirects to external sites. (docs)

Operations

  • Upgrade to Java 12 - We strongly recommend upgrading your server installations to Oracle OpenJDK 12 as soon as possible. 19.1.x installations will continue to run on Java 11, but site administrators will see a warning banner. Oracle has ended public support for Java 11; as a result, LabKey will completely remove support for Java 11 in the 19.2.0 release. For details see Supported Technologies.
  • Remove Support for Java 8 - Oracle ended public support for Java 8 in January 2019; as a result, LabKey Server no longer supports Java 8. For details, see Supported Technologies.

Potential Backwards Compatibility Issues

  • Remote API Date Format Change - The date format in JSON responses has been changed to include milliseconds: "yyyy-MM-dd HH:mm:ss.SSS". In previous releases the following format was used: "yyyy/MM/dd HH:mm:ss".
  • Removal of Legacy JFree Chart Views - Existing charts of these older types are rendered as JavaScript charts. No action is needed to migrate them. (docs)
  • Legacy MS2 Views - Options in the Grouping and Comparison views previously marked as "legacy" have been removed.
  • User and Group Details Access Change - Access to contact information fields in the core.Users and core.SiteUsers queries, the core.Groups query, and the getGroupPerms API now require the Administrator or "See User and Group Details" role.
  • External Redirects Change - External redirects are now restricted to the host names configured using the new Configure Allowable External Redirects administration feature. The 18.3.x experimental feature that unconditionally allowed external redirects has been removed.
  • POST Method Required for Many APIs - Many LabKey APIs and actions have been migrated to require the POST method, which has security benefits over GET. The LabKey client APIs have been adjusted to call these server APIs using POST, but code that invokes LabKey actions directly using HTTP may need to switch to POST.

Upcoming Changes

  • End of Support for IE 11 - Support for IE 11 will end in the upcoming LabKey Server 19.2.0 release, scheduled for July 2019. Please contact us for workaround options if this change strongly impacts you. (docs)

Version 18.3, released November 2018

Panorama

  • Normalized Y-axes in QC Plots - Support for normalizing Levey-Jennings and Moving Range plots using percent of mean or standard deviation as the zero point on the Y-axis. (docs)
  • Improved Figures of Merit performance - Rendering performance for the Figures of Merit report has been improved. (docs)
  • Read Chromatograms Directly from SKYD files - An experimental feature allows you to read chromatograms directly from SKYD files instead of storing them in the database. (docs)

Administration

  • Subfolder Web Part - This web part shows the subfolders of the current location; included in new collaboration folders by default. Also available in the 18.2 release. (docs)
  • Connect to Existing Amazon S3 Directories - Connect to an existing S3 directory or create a new one for each LabKey folder. (docs)
  • Improved Navigation Menu - The project menu and any custom menus you define have a more consistent interface, and each contain graphical elements signaling that they are interactive elements. You can also access the project menu from the admin console. (docs)

Reporting and Visualization

  • Scatter and Line Plot Enhancements - Specify multiple Y axes. Show all data on a single plot or display separate plots per measure. (docs | docs)

Development and APIs

  • NaN and Infinity Values - LabKey SQL supports constants NaN, INF, and -INF. (docs)

Potential Backwards Compatibility Issues

  • Changes to CSRF Setting - At 18.3 upgrade time, the CSRF checking setting on all servers will be set to "All POST requests". Site administrators will have the ability to revert back to "Admin requests" for deployments that still need to make their external modules or custom pages compatible with this setting. For release 19.1, we plan to remove the setting entirely and check CSRF tokens on every POST (except for specially annotated actions). When servers are protecting against CSRF attacks, they will require the following minimum versions: Skyline - 4.2; Skyline-daily - 4.1.1.18151; AutoQC Loader - 1.1.0.18302 (docs)

Operations

  • Support for Java 11 - We recommend upgrading your server installation to Java 11. Oracle is expected to end public support for Java 8 in January 2019, and, as a result, LabKey Server will no longer support Java 8 for the 19.1 release. For details see Supported Technologies.
  • Support for PostgreSQL 11 - PostgreSQL 11.1 and above is supported (not the initial PostgreSQL 11.0 release). For details, see Supported Technologies.
  • Remove support for PostgreSQL 9.3 - PostgreSQL 9.3 reached end-of-life in November 2018. We recommend upgrading your PostgreSQL installation to version 10 or later. For details, see Supported Technologies.
View the full LabKey Server 18.3 release notes.

Version 18.2, released July 2018

Panorama

  • Improved Pharmacokinetic Report - Pharmacokinetic (PK) calculations are provided per subgroup, replicate annotations are included, and non-IV routes of administration are supported. (docs)
  • LOD/LOQ Skyline Compatibility - Limit of Detection (LOD) is now shown in Panorama, and there is support for additional Limit of Quantitation (LOQ) configuration as defined in Skyline. (docs)

System Integration

  • Spotfire Integration - Use data stored in LabKey Server to create Spotfire visualizations. (docs)

LabKey SQL

  • Common Table Expressions - Use a SQL "WITH" clause to simplify complex queries and create recursive queries. (docs)

Development

Potential Backward Compatibility Issues

  • Changes to CSRF Default Setting In 18.2, we have switched the default CSRF checking setting (affecting only new servers) to "All POST requests". We recommend that all clients run their servers with the "All POST requests" setting, ideally on production servers but at a minimum on their tests/staging servers. In the upcoming 18.3 release, we plan to force the setting (on all existing servers at upgrade time) to "All POST requests". We will retain the ability to revert back to "Admin requests" for deployments that still need to make their external modules or custom pages compatible with this setting. For release 19.1, we plan to remove the setting entirely and check CSRF tokens on every POST (except for specially annotated actions).

Operations

  • Tomcat 8.0.x is no longer supported - If you are using Tomcat 8.0.x, you should upgrade to 8.5.x at your earliest convenience. No configuration changes in LabKey Server are necessary as part of this upgrade. For details see Supported Technologies.
  • Connection Pool Size - We recommend reviewing the connection pool size settings on your production servers. For details, see Troubleshooting.
View the full LabKey Server 18.2 release notes.

Version 18.1, released March 2018

Panorama

  • Pharmacokinetic Calculations - See the stability, longevity, and uptake of compounds of interest. (docs)
  • Figures of Merit for Quantitation Data - Summary statistics show the mean, standard deviation, and %CV for the replicates, along with lower limit of detection, quantitation, etc. (docs)

Collaboration

  • Files Table - All files under @files, @pipeline, and @filesets in a container can be managed using a new exp.Files table. Developers can use exp.Files to programmatically control all files at once. (docs)
  • Messages Default to Markdown - Markdown is a simple markup language for formatting pages from plain text, similar to LabKey's Wiki syntax. The Messages editor window includes a Markdown syntax key and message preview tab. (docs)

Security

  • New Role: See Absolute File Paths - A new site-level role allows users to see absolute file paths in the File Repository. (docs)
  • Impersonation Auditing - Audit records are created when a user starts or stops impersonating a role or group. docs)
  • API Keys - Client code can access the server using API keys. Administrators can allow users to obtain new API keys and manage when keys expire. (docs)
  • Captcha for Self Sign-up - Self-registration now includes a captcha step to prevent abuse by bots. (docs)
  • Cross-Site Request Forgery (CSRF) Protection Changes - All LabKey pages have been tested and updated to protect against CSRF. We recommend that site admins change the default CSRF protection setting to "All POST requests" to enable this increased protection. This may cause issues with custom pages that are not configured to submit CSRF tokens when doing an HTTP POST. For details see the Potential Backwards Compatibility Issues section below.

Operations

Potential Backwards Compatibility Issues

  • New Cross-Site Request Forgery Protection (CSRF) Recommendation - We recommend that administrators begin the process of converting their servers from the current default CSRF protection setting of "Admin requests" to "All POST requests". The more stringent security setting may cause issues for custom pages that submit HTTP POST requests. If you have no custom pages or forms, we recommend that you immediately change the CSRF setting for all test, staging, and production servers running 18.1. If you have custom pages and forms, we recommend that you begin testing on your test and staging servers. In a future release, LabKey Server will enforce that all HTTP POSTs include the CSRF token, at which point all custom pages will be required to be do so. For details on configuring custom pages with CSRF protection, see here.
View the full LabKey Server 18.1 release notes.



Create a Folder in Panorama


To get your data into Panorama, first create a folder.
  • Hover over your project name in the menu bar below the Panorama icon and click on the New Subfolder icon shown in the image below.
  • Give the new folder a Name.
  • Select the Panorama option under Folder Type. This is the folder type that should be selected for all workflows supported by Skyline (SRM-MS, MS1 filtering or MS2 based projects).
  • On the Users / Permissions page, select one of the available options and click Next.
    • You can also change permissions on a folder after it has been created.
  • The next page, Configure Panorama Folder, asks you to choose the type of Targeted MS folder you would like to create. Panorama offers several choices here:
    • Choose the Experimental data option for folders that serve as a repository of Skyline documents, useful for collaborating, sharing and searching across multiple experiments.
    • Choose the Multi-attribute method (MAM) option for an Experimental data folder including additional reporting for multi-attribute method analyses.
    • Choose Chromatogram library to store curated assays that can be used for designing and validating future experiments.
    • Check Rank peptides within proteins by peak area if your data contains relative peptide expression for proteins.
  • Choose the Quality control (QC) option for tracking performance of mass spec. instruments over time.
  • Click Finish.


Changing the folder type

If you forget to select "Panorama" as the folder type option when creating a new folder, the folder will not be recognized by Skyline as a folder where it can upload Skyline documents. The folder will also not have the layout that you expect to see in a "Panorama" folder. For example, the Raw Data tab where you can upload raw files will not be available. You can change the folder type by following these steps:
  • Click the gear icon in the top right corner and select Folder and then Management
  • In the Folder Management interface select the Folder Type tab as show in the image below
  • Select Panorama as the folder type option and click the Update Folder button



See the LabKey documentation for more information:



Folder Navigation in Panorama


To navigate to your available projects and subfolders, hover over the folder icon or the current project name, located at the top left corner, just under the Panorama logo. 

Project navigation: Hovering over the folder icon to the left displays all the projects that you have access to on PanoramaWeb. Clicking on the project name (e.g. “MacCoss”) will take you to the home page of the project.

Folder navigation: The menu provides a tree view with expandible/collapsable nodes for navigation to sub-folders. Clicking on a folder name navigates to the home page of the folder.

Also see: LabKey Documentation: Navigate Server




Adding Users to a Project


If you are the administrator of a project on panoramaweb.org, you can follow these steps to add users from your lab or organization to the project.

 

  • Click on the Gear Icon  , as shown in the image below.
  • Click Folder and then click  Permissions.

  • On the permissions page click on the Project Groups tab.
  • Click on the "Users" group.  This is a group that is created for every project on Panorama.

  • In the Users Information popup click on Manage Group.

  • Enter the email addresses of new users in the Add New Members text box. 
  • Click on Update Group Membership.

  • Any users that did not already have accounts on the Panorama server will be added to the system, and a welcoming email will be sent to them.
  • Click on Permissions in the navigation trail, as shown in the image below, to go back to the permissions page.

  • Assign the Users group to the Reader role, as shown in the image below.  All users that are members of the Users group will have read access to the project.

 

To make a folder public assign Site:Guests to the Reader role. Anyone with a link to the folder will be able to view it without having to log in.

For more information on the adding / managing users and security roles look at the LabKey documentation on LabKey security architecture.




Import Data Into Panorama


You can import data into a Panorama server either directly from Skyline or from Panorama's web-browser interface.

Importing data into a Panorama server from Skyline

Open the document that you want to publish to Panorama.

  • Click on the Upload to Panorama button in the toolbar, as shown below.  Alternatively, on the File menu, click Upload to Panorama.

  

  •  If you have not already registered a Panorama server in Skyline you will see the following message.

If you have an existing account on a Panorama server, and you would like to use that, click Continue and enter the server details in the Edit Server form Skyline presents.  If you do not have an existing Panorama account, you can request a project on the PanoramaWeb server hosted at the University of Washington by clicking Register.


In the Edit Server form enter the server URL and the email address and password for your account on the server. Click OK. Skyline will now display a form with the folder hierarchy on the Panorama server.

  • Select a folder on the server where you want to add the document.
  • Click the OK button. 

Skyline will create a ZIP archive of the files for your document and upload the ZIP file to the Panorama server, where it will be imported into the Panorama database. 

 




 

Importing data into a Panorama server via a web-browser

Using the Skyline Upload to Panorama toolbar button or menu item is the most convenient way to get your documents into Panorama.  But this can also be done by using the Panorama web interface.

  • In Skyline, open the file you want to upload to Panorama.
  • In the File menu click Share.
  • If the document uses spectral libraries or a background proteome:
    • Click the Minimize libraries radio button to share only the library spectra used in your document
    • Click the Store everything radio button to share the libraries and background proteome files as they exist on your system

  • Save the ZIP file on your computer using the Share Document form presented by Skyline.
  • In Panorama, navigate to your folder.
  • Click the Data Pipeline tab in the upper right corner.
  • Click Process and Import Data as shown below.

  • In the Files browser, click Upload Files
  • Click the Browse button and select the file that you want to import.
  • Click the Upload button.

Once the file has been uploaded it will appear in the list of files in your folder

  • Check the box next to your file name.
  • Click Import Data in the toolbar, beside the Upload Files button

.

Wait for the file import to complete and then click the Panorama Dashboard tab in the upper right corner.  Your file should be listed under Targeted MS Runs. You can click the file name to view the results in the Skyline document. 

 






Adding Links in Wiki Pages


Wiki pages are one of the tools that can be used to include additional, supplementary content in a folder that will submitted to Panorama Public. A Wiki page can have static text and image content as well as links to other files. The general rule of thumb for links is that if the URL for a file that you are linking to in a Wiki page begins with "https://panoramaweb.org.." then the link is absolute, and it has to be converted to a folder-relative link. Otherwise, when the folder gets copied to Panorama Public the link in copied Wiki page will still point to the file in the source folder rather than the copied file in the Panorama Public folder.

Relative links to files

If a file is less than 50MB in size, it can be attached to a Wiki page. See this page for more information on attaching files: Using File Attachments in Wikis .
To add a link to a file that is attached to the Wiki page use the name of the file in the HTML source editor rather than the absolute URL of the file. Using the name of the file in the href attribute of the <a> tag, for example, will create a link that is relative to the folder, and will get copied correctly to Panorama Public. For FILENAME.csv attached to a Wiki page, for example:
  • DO THIS: <a href="FILENAME.csv">
  • NOT THIS: <a href="https://panoramaweb.org/home/wiki-download.view?entityId=46e23841-ce54-103a-b0fb-a091112fcade&name=FILENAME.csv">
This is also relevant when adding images to a wiki page. Use the name of the attached image file in the src attribute of the <img> tag instead of the absolute URL. Example:
  • DO THIS: <img src="IMAGE.png">
  • NOT THIS: <img src="https://panoramaweb.org/home/wiki-download.view?entityId=46e23841-ce54-103a-b0fb-a091112fcade&name=IMAGE.png">


Wiki pages can also contain links to files that have been uploaded to the Raw Data tab (See Upload Raw Data) or added as supplementary files (See Upload Supplementary Files). For example, if FILENAME.csv has been uploaded as a supplementary file, and its absolute URL is:

https://panoramaweb.org/_webdav/Example%20Data/%40files/SupplementaryFiles/FILENAME.csv

To create a link relative to the folder
  • replace https://panoramaweb.org/_webdav/...%40files/ WITH filecontent-sendFile.view?fileName=
  • Add &renderAs=attachment at the end of the URL if you want the file to be downloaded rather than displayed in the web browser.
The folder-relative link will look like this:

filecontent-sendFile.view?fileName=SupplementaryFiles/FILENAME.csv&renderAs=attachment

Relative links to Skyline documents

To link to a Skyline document in a Wiki page, get the folder-relative URL for the document from the Targeted MS Runs grid by clicking the download icon next to the document name and selecting Copy relative URL to clipboard.


Relative links to folder tabs

To get the link to a tab in a folder (e.g. Raw Data tab), right-click the tab and select "Copy link address" (in Google Chrome) or "Copy Link" (in Firefox). Paste the link as the href attribute of an <a> tag in a Wiki page. For example:
<a href="https://panoramaweb.org/home/Example%20Data/project-begin.view?pageId=Data%20Pipeline">

To convert the absolute URL to a folder-relative link remove everything until project-begin.view?.
The folder-relative link will look like this:
<a href="project-begin.view?pageId=Data%20Pipeline">



Panorama Public





Submit Data to Panorama Public


PanoramaWeb hosts a public repository called Panorama Public where users may submit supplementary data associated with manuscripts that have been published or are under review. The repository provides a permanent location for data that can be referenced in publications. Users with data in their own projects on PanoramaWeb can follow the instructions below to submit the data to Panorama Public. The PanoramaWeb site administrators will review the submission request and make a copy of the data to Panorama Public. Reviewer account details will be provided to the submitter if the data is for a manuscript undergoing peer review, and the copy on Panorama Public will be kept private until the manuscript is accepted for publication. Data copied to Panorama Public is read-only, ensuring its availability in the original form accepted for publication.

Panorama Public is a member repository of the ProteomeXchange consortium. Data submitted to Panorama Public that fulfills ProteomeXchange submission requirements will be assigned a ProteomeXchange identifier and announced on ProteomeCentral.

Submitting Data to Panorama Public

STEP 1: Upload Skyline documents and other files to a folder on PanoramaWeb

Refer to the following wiki pages to create a folder in your project on PanoramaWeb and upload Skyline documents and associated data.


STEP 2: Prepare the folder for submission to Panorama Public

Folders containing supplementary data intended for submission to Panorama Public have to be annotated with a description of the experiment. This includes information such as an abstract, experiment and sample descriptions, organism, MS instruments used etc. To add experiment annotations to a folder, do the following:

  • Go to the home page of the folder by navigating the folder menu under the Panorama logo (Folder Navigation).
  • Click the gear icon in the top right corner of the page, then select Page Admin Mode from the drop-down menu.
  • Scroll to the bottom of the page and select Targeted MS Experiment from the <Select Web Part> menu at the bottom-left of the page.
  • Click the Add button. This action will add a web part titled Targeted MS Experiment at the bottom of the page that looks like this:
  • Click the Create New Experiment link in the Targeted MS Experiment web part.
  • Fill out the Targeted MS Experiment form.

The Instrument and Organism fields are auto-complete fields. Type 3 or more letters to see a drop-down list of matching options. Continue typing to refine the list and select from one of the available options. Contact the Panorama team if you do not see your instrument or organism in the list. At least one organism and one instrument is required for a ProteomeXchange submission.

In addition to an organism and an instrument, Keywords describing the data also need to be filled in for a ProteomeXchange submission. Contact details of the data submitter and a lab head are also required. In the Targeted MS Experiment form, the currently logged in user is auto-selected as the submitter. Please fill in the Submitter Affiliation for the submitting user. You can select a lab head from the drop-down menu in the Lab Head field which lists all users that have administrative privileges in the folder. If your lab head does not have an account on the server, you may create one by referring to Adding Users to a Project. If you do not wish to create an account for the lab head you can leave the Lab Head and Lab Head Affiliation fields blank. You will have the option of entering a lab head name and affiliation when you submit the data to Panorama Public.

  • Click the Submit button at the bottom of the form.
You will be taken to the experiment details page. All the Skyline documents that were uploaded to the folder where you added the Targeted MS Experiment webpart will get added to the experiment and will appear in the Targeted MS Runs table. If your data is organized in subfolders under the main folder, you should click the Include Subfolders button shown in the image below. For more information see Include Subfolders in a Panorama Public Submission.


STEP 3: Submit the annotated folder to Panorama Public
  • Navigate back to the folder home page by clicking on the link with the icon and folder name near the top of the page.
  • Scroll down, if you need to, so that you can see the Targeted MS Experiment web part.
  • Click the red Submit button in the Targeted MS Experiment web part.


If the Skyline documents in the folder you are submitting contain proteomic data, you will have the option of getting a ProteomeXchange ID for your data. After you click the Submit button you will see a page with a button to validate the data for a ProteomeXchange submission.

Click the Validate Data for ProteomeXchange button to start the data validation process. This process will:
  • Verify that all the raw data files imported into your Skyline documents have been uploaded
  • All the modifications used in your Skyline documents have a Unimod Id
  • The source files (raw data + search results) used to build the spectral libraries used in your documents have been uploaded.
Clicking the button will redirect you to a page where you will see the validation progress. This page will refresh the status every 5 seconds.


After the validation job is complete a detailed status report is displayed showing the validation status. A summary list of any problems found is included in the main Data Validation Status panel. Details are displayed in the tables below this panel.


If your data is valid for a "complete" ProteomeXchange submission, you can click the Continue Submission button to proceed with the submission. Otherwise, you can try submitting again after you have provided all the missing information. You also have the option of submitting without a ProteomeXchange ID, or continuing with an "incomplete" ProteomeXchange submission.


NOTE: ProteomeXchange IDs can only be assigned to proteomic data. If your Skyline documents do not contain any proteomic targets then you will not be presented with the option to get a ProteomeXchange ID.

After you click the button on the data validation page, you will see a form that looks similar to the one in the image below.
  • The Get ProteomeXchange ID checkbox will be displayed only if the data is valid for a "complete" or "incomplete" ProteomeXchange submission.
  • If you did not enter a lab head in the Targeted MS Experiment form, you will be able to enter the lab head details in the submission form. If you do not fill in the lab head details in this form, the submitting user's information will be used in the lab head field when announcing the data to ProteomeXchange.



In the Submission Request to Panorama Public form do the following:
  • Select “Panorama Public” from the drop-down list next to the Submit To option, if it is not already selected
  • Enter an Access Link
  • If you are submitting data for a manuscript undergoing peer review leave the Keep Private box checked. This will ensure that when the data is copied to Panorama Public, it will be kept private with read-only access to the submitter. A read-only reviewer account will be created for the data, and account details provided to the submitter. The account details can be conveyed to the journal where the manuscript is submitted. If you want your data to be publicly available on Panorama Public right away uncheck the Keep Private checkbox.
  • Click the Submit button
Access Link is the link that you will include in your manuscript to link to supplementary data on Panorama Public that can be viewed in a web browser. Initially, this link points to your folder on PanoramaWeb. But once a copy of your data has been made to Panorama Public, it will link to the location of the copied data on Panorama Public. This will be the permanent location of your data on Panorama Public.

The Publish Experiment form allows you to “build” these the access link. The initial part of the link remains constant: https://panoramaweb.org/. You can choose a string to complete the link (highlighted in yellow below).
https://panoramaweb.org/choose_a_string.url
The initial value entered in the Access Link field is a randomly generated alphanumeric string. You can replace it with a convenient, easy to remember string. This string has to be unique across all the experiments published to Panorama Public. You may get an error if the link you entered is already in use for another experiment on Panorama Public. If this happens change the text in the access link field and try again.

Requests to copy data are handled by Panorama Public administrators within a week of submission. Once your data has been successfully copied to Panorama Public you will receive a confirmation email. If you requested that your data on Panorama Public be kept private (e.g. for a manuscript under peer review), the confirmation email will also include reviewer account details. You can pass on the account details to the journal where you are submitting your manuscript. The confirmation email will also include a ProteomeXchange ID unless you opted to skip ProteomeXchange submission.

Once the form is submitted successfully you can go back to the experiment details page.

In the Experiment Details box, just above the experiment title, you will see a “Copy Pending!” message. This message will disappear once your data has been copied to Panorama Public. Any changes that you make in the folder, such as adding/removing Skyline documents or wiki pages, or changing the layout of the page will also get copied when a copy is made to Panorama Public. At the bottom of the page, in the Submission table, you will see the Access Link that you created for this experiment. The Copied column will be blank until a copy has been made successfully. Once the data has been copied this column will display the date when the data was copied. And at that point if you click the Access Link you will be taken to the location on Panorama Public where your data was copied. You can verify that the data, folder layout and views were copied accurately.


If you need to make any changes to your data (e.g. to address reviewer feedback) after it has been copied to Panorama Public you can make the changes in your own folder. When you are ready click the red Resubmit button in the Targeted MS Experiment web part. This will send a request to the Panorama Public administrators to delete the old copy and make a new copy of your data to Panorama Public. Your access link will remain unchanged.


Related Resources:



Upload Raw Data




Upload raw data in a web-browser

Raw data associated with Skyline documents in a folder can be uploaded via the Raw Data tab in the top right corner.
(NOTE: If you don't see a Raw Data tab click here for instructions on how to add it)



Click the tab to see a Files browser. You can drag-and-drop files and/or folders located on your computer onto the Files browser as shown in the image below.



Another way to upload files is to click the Upload Files button in the Files browser, and click Browse to navigate to and select the file you want to upload.



Organizing data in folders

Raw data files can be organized in folders. Create a new folder by clicking the new folder button in the Files webpart.


Enter a name for the folder and click Submit.


Click the Show or Hide Folder Tree button to show the folder tree panel.


Click the newly created folder in the folder tree panel to select it. The right panel will update to show the contents of the selected folder. Drag-and-drop files in the right panel to upload them to the new folder.



More information on using the Files browser can be found here: Using the Files Repository


Upload raw data by mapping a network drive in Windows

On a Windows machine you can map your PanoramaWeb folder as a network drive and copy files to the folder using Windows Explorer. This uses WebDAV for file transfer, and Windows XP and later have a built-in WebDAV client.

NOTE: The instructions below will work on Windows 10 and Windows Server 2016. If you have an older operating system and are unable to map a network drive with these steps then you can use a third party WebDAV client such as Cyberduck. Look at this page for instructions on setting up Cyberduck and for a list of other WebDAV clients: Example Setup for Cyberduck WebDAV Client

To map a PanoramaWeb raw data folder as a Windows network drive follow these steps:

Get the WebDAV URL

  • In a web-browser navigate to the Panorama folder and click the Raw Data tab
  • Click the Upload Files button in the Files webpart (1. in the screenshot below)
  • Click the "Upload file" icon (2. in the screenshot below).
  • From the File Upload Help dialog copy the WebDav URL (3. in the screenshot below)

  • On your computer open Windows Explorer. Right-click This PC in the left pane and select Map network drive from the menu


  • In the Map network drive dialog enter the WebDav URL that you copied from your Panorama folder. Check Connect using different credentials and click Finish
  • You will be prompted for a username and password. Enter your PanoramaWeb email address and password and click OK
This should map the PanoramaWeb folder as a network drive on your computer, and you should be able to copy files to the folder just as you would to a another folder in Windows Explorer. Once you are done copying files you can disconnect the network drive by right-clicking the mapped drive and selecting Disconnect network drive from the menu.

Using Cyberduck (https://cyberduck.io/)

  • Click Open Connection.

  • In the Open Connection dialog select WebDAV (HTTPS) as the connection type.
  • Get the WebDAV URL as described above and enter it in the Server field. CyberDuck will automatically parse the URL and populate the Path field.
  • In the Username field enter your email address on PanoramaWeb.
  • Enter you password in the Password field.
  • Click Connect.




Upload raw data on the command line

If you are comfortable using the command line, you can use rclone to upload your raw files. Rclone is a command line utility to sync files to and from the cloud. Among the many cloud providers it can sync with, one is webdav. Webdav can be used to access files on PanoramaWeb.

You can download rclone from https://rclone.org/downloads/. If you are on Windows I recommend that you download the `AMD64 - 64bit` version.

The first step is find WebDav URL

  • In a web-browser navigate to the Panorama folder and click the Raw Data tab
  • Click the Upload Files button in the Files webpart (1. in the screenshot below)
  • Click the "Upload file" icon (2. in the screenshot below).
  • From the File Upload Help dialog copy the WebDav URL (3. in the screenshot below)



Setup a remote for your folder on Panoramaweb

Start the interactive configuration session

rclone.exe config edit
No remotes found - make a new one
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Create a name. I recommend using the name of the server or something that is easy for your to remember

name> PanoramaWebFiles

Next it will ask you to choose the type of storage location to configure. We will be using webdav

Type of storage to configure.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
1 / 1Fichier
"fichier"
2 / Alias for an existing remote
"alias"
3 / Amazon Drive
"amazon cloud drive"
...
33 / Webdav
"webdav"
34 / Yandex Disk
"yandex"
35 / http Connection
"http"
36 / premiumize.me
"premiumizeme"
Storage> 33
Now we will enter URL for the FileRoot of your PanoramaWeb folder
URL of http host to connect to
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
1 / Connect to example.com
"https://example.com"
url> https://panoramaweb.org/_webdav/ExampleProject/Folder/@files/

Now choose `other` when asked what type of service we are using

Name of the Webdav site/service/software you are using
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
1 / Nextcloud
"nextcloud"
2 / Owncloud
"owncloud"
3 / Sharepoint
"sharepoint"
4 / Other site/service or software
"other"
vendor> other

Enter the email address that you use for logging into the PanoramaWeb server

User name
Enter a string value. Press Enter for the default ("").
user> bconn@proteinms.net
Here you will be asked to enter your password.
Password.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank (default)
y/g/n> y
y/g/n> y
Enter the password:
password:
Confirm the password:
password:
Choose the default option for the next two questions
Bearer token instead of user/pass (eg a Macaroon)
Enter a string value. Press Enter for the default ("").
bearer_token>
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n> n
We are almost done. Here you will just confirm the information that you entered and then quit.
Remote config
--------------------
"missing" href="/home/wiki-page.view?name=PanoramaWebFiles">PanoramaWebFiles
type = webdav
url = https://panoramaweb.org/_webdav/ExampleProject/Folder/@files/
vendor = other
user = bconn@proteinms.net
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> yes
y/e/d> y
Current remotes:

Name Type
==== ====
PanoramaWebFiles webdav

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q> q



Copying files

To copy a file to PanoramaWeb, you can use the command
rclone.exe --progress copy FILENAME PanoramaWebFiles:

If you would like to copy a directory to the PanoramaWeb, you can use the command

rclone.exe --progress copy DIRECTORY_TO_COPY PanoramaWebFiles:

If a copy fails to complete for whatever reason, you can simply run the command again and rclone will only copy up the files which failed. If you would like to see a list of the files which are copied, you can add the `-v` option to the command line.




What to do if the Raw Data tab is missing or has an error

The Raw Data tab is added by default when you create a new "Panorama" type folder. Some older folders may not have this tab. If you do not see the Raw Data in a "Panorama" type folder, and you are the administrator of the folder, you can add it as follows:
  • Click the gear icon in the top right corner
  • Select Add Raw Data Tab from the drop-down menu


The Raw Data tab provides a view into a "RawFiles" directory on the server's file system. If the "RawFiles" directory is somehow deleted you will see an error when you click the Raw Data tab.


If you see the error message above or something like "File root directory configured for this webpart could not be found", first remove the Raw Data tab and then add it back. To remove the tab:
  • If you are not in page admin mode, click the gear icon in the top right corner and select Page Admin Mode from the menu
  • Click the Raw Data tab and click OK in the Error dialog
  • Click the little triangle in the right corner of the tab to access the control menu and select Delete

After this follow the steps above to add the Raw Data tab. This will create the "RawFiles" directory on the file system.



Upload Supplementary Files


The Files webpart or the file browser in Panorama can be used to upload any additional supplementary files that you may want to make available with your data on Panorama Public. To add a Files webpart
  • Click the gear icon in the top right corner and select Page Admin Mode from the menu
  • Scroll to the bottom of the page and select Files from the <Select Web Part> menu at the bottom-left of the page
  • Click the Add button
This will add a file browser at the bottom of the folder homepage.

In the file browser you will see a "RawFiles" folder. This folder is automatically created for every "Panorama" type folder. This is the folder where raw files associated with Skyline documents should be uploaded. The Raw Data tab provides a view into this folder. Look at [Upload Raw Data] for more details. In the file browser you should also see the Skyline documents (.sky.zip files) that were uploaded to the folder. For each Skyline document where will be an exploded directory (containing the .sky, .skyd etc. files), as well as a log file that was created when the document was imported.

Files and folders can be uploaded by selecting them on your computer and then dragging and dropping them on top of the file browser. It may be a little hard for viewers to locate supplementary files in the default view of the file browser if there are multiple Skyline documents uploaded to the folder. To provide a cleaner view, you can create a sub-folder for supplementary files and customize the file browser to display only the contents of that folder. A new folder can be created by clicking the "Create a new folder" button in the tool bar of the file browser as shown below. You can name the folder whatever you like. Here it is named "SupplementaryFiles".


Double click the new folder to open it. Alternatively, click the "Show or hide the folder tree" icon in the toolbar to split the file browser into two panels. The left panel shows an expandable tree view of the folder structure, and the right panel displays the contents of the folder selected in the left panel. Select the folder just created (e.g. "SupplementaryFiles") and drag and drop files on top of the right panel to add files to this folder.


Next, customize the Files webpart to display only the contents of the "SupplementaryFiles" folder. To do this:
  • Click the little triangle in the top right corner of the Files webpart and select Customize from the control menu
  • In the Customize Files form enter a name in the Title field
  • Select the "SupplementaryFiles" folder in the File Root tree
  • Click Submit


The file browser will now show the contents of the "SupplementaryFiles" folder. More than one Files webpart can be added to a folder page and each one can have different customization settings.


Adding a new tab for supplementary files

The Files webpart can also be added to a new tab on the page, like the Raw Data tab. To add a new tab first make sure you are in the Page Admin mode. If you are, you will see an Exit Admin Mode button in the top right corner of the browser window. If you don't see the button, do this to enter Page Admin mode:
  • Click the gear icon in the top right corner and select Page Admin Mode from the menu

To add a new tab:
  • Click the "+" icon to the right of the Raw Data tab
  • Enter "Supplementary Data" in the Add Tab form, and click OK


A Files webpart can now be added to the new "Supplementary Data" tab by selecting "Files" from the <Select Web Part> menu. The files browser can be configured, as described above, to show the contents of the folder that has the supplementary data files.



Include Subfolders in a Panorama Public Submission


Data submitted to Panorama Public can be organized in subfolders. If you submit a folder to Panorama Public that has subfolders, you will be asked to confirm that you want to include subfolders in your submission request.


Click Include Subfolders And Continue to configure the experiment to include subfolders.
Click Skip Subfolders and Continue if you do not want to include any of the subfolders. When you choose this option only the contents of the main folder will be copied to Panorama Public.

To include subfolders in a submission request the user must have read permissions in all the subfolders. If you do not have read permissions in one or more of the subfolders you will this following message.



You can also configure a folder to include (or exclude) subfolders prior to submitting. To do this, click the [More Details] link in the Targeted MS Experiments webpart to go to the experiment details page. On this page you will see a panel titled Subfolders if there are subfolders.


Click the Include Subfolders button to configure the experiment to include subfolders. The page will refresh and you will see a list of all the subfolders that are included in the experiment. These subfolders will be copied to Panorama Public when the data is submitted.




Data Validation for ProteomeXchange



Proteomic datasets submitted to Panorama Public can be assigned a ProteomeXchange ID if they fulfill the ProteomeXchange data guidelines. To get a ProteomeXchange ID all the raw data files imported into the Skyline documents must be uploaded. This is the minimum requirement for getting a ProteomeXchange ID. See Upload Raw Data for details on how to upload raw data. In addition to the raw data the following are also required for a "complete" ProteomeXchange submission:
  • All modifications used in the Skyline documents must have Unimod Ids
  • If the Skyline documents include spectral libraries then all the source files (raw + search results) used to build the libraries must be uploaded

When a dataset is submitted, it is validated for a ProteomeXchange submission. The validation process runs as a pipeline job, and the results are displayed after the job is complete. The summary panel at the top of the page displays the validation status and any problems that were found during data validation.


You will see this status message if the data is valid for a "complete" ProteomeXchange submission. This means:
  • All the raw data files used with the Skyline documents were uploaded
  • All the modifications used with the Skyline documents had Unimod Ids OR there were no modifications
  • The source files (spectrum files + search results files) used to build the spectral libraries were uploaded OR there were no spectral libraries



You will see this status message if
  • All the raw data files used with the Skyline documents were uploaded
  • BUT, one or more modifications in the Skyline documents did not have a Unimod Id OR the source files used to build one or more spectral libraries were not uploaded
The data can be assigned a ProteomeXchange ID. However, it will be marked as "supported by repository but incomplete data and/or metadata" when it is announced on ProteomeXchange.


You will see this status message if one more raw files used with the Skyline documents were not uploaded. The data cannot be assigned a ProteomeXchange ID but it can still be submitted to Panorama Public by clicking the Submit Without a ProteomeXchange ID button.


Validation details for Skyline documents (sample files), modifications and spectral libraries are displayed in the tables below the validation summary panel.

Sample file validation table

The Skyline Document Sample Files table displays the status for each Skyline document in the dataset. If all the raw data files imported into the document were uploaded, the status displayed is Complete. Otherwise, the status displayed is Incomplete.


The nodes in the table can be expanded to view the list of replicates and sample files in each document.



Modifications validation table

The Modifications table displays a list of modifications found in the Skyline documents. For a "complete" ProteomeXchange submission all the modifications must have a Unimod Id. Skyline supports an extensive set of Unimod modifications, and it is recommended that you use modifications from the built-in list of Unimod modifications rather than define your own custom modifications. If you are unable to find your desired modification in Skyline then please post to the Skyline or Panorama support boards.
The modifications table will display Missing in the Unimod Match column if the modification in the Skyline document did not have a Unimod Id. Otherwise, the Unimod Id is displayed. Clicking on a Unimod Id will take you to the modification page on the Unimod website.


Expand the nodes by clicking the '+' icon in the first column to view the Skyline documents in the dataset that use the modification along with a link to the peptides in the document with the modification.



If any of the modifications did not have a Unimod Id you can click the Find Match link. This will attempt to find a Unimod match for the modification based on the modification formula and the modified amino acids and / or terminus information found in the modification definition in the Skyline document. Read more about finding Unimod matches on this page: Finding Unimod Matches.

Spectral library validation table

The Spectral Libraries table has a row for each spectral library used with the Skyline documents in the dataset. The library status, in the Status column is Complete if the library is supported and all the source files used to build the library were uploaded. Otherwise the status is Incomplete. Each row can be expanded by clicking the '+' icon in the first column to view a list of source files for the library along with links to Skyline documents that use the library.



Finding Unimod Matches


For a “complete” ProteomeXchange submission all the modifications used in the submitted Skyline documents are required to have a Unimod Id. Without Unimod Ids, the data can still be assigned a ProteomeXchange ID, but the data will be annotated as "supported by repository but incomplete data and/or metadata" when it is announced to ProteomeXchange.

View Data Validation for ProteomeXchange for more details.

Skyline supports an extensive set of Unimod modifications, and it is recommended that you use modifications from Skyline's built-in list of modifications rather than define your own custom modifications. If you are unable to find your desired modification in Skyline, please post to the Skyline or Panorama support boards.
The sections below cover the following:

If a modification is not associated with a Unimod Id, you will see a Find Match link for the modification in two locations:
  • If you have already run ProteomeXchange data validation on the data, and are looking at the validation results, you will see the Find Match link in the Unimod Match column of the Modifications table.


  • Another location where you will see the Find Match link is on the experiment details page in the Structural Modifications and Isotope Modifications tables. These tables list the structural and isotope modifications used in the dataset. You can go to the experiment details page by clicking the [More Details...] link in the Targeted MS Experiment webpart.



Assign a Unimod match

It is highly recommended that you use a modification from Skyline's built-in list of structural and isotope modifications, since those modifications have a Unimod Id. However, if there are custom modifications in your documents that do not have a Unimod Id, you can find a Unimod match for those modifications on Panorama if the modification definition has a modification formula (or labeled atoms for isotope modifications), the modified sites (amino acids) and / or the modified terminus. To find a Unimod match do the following:
  • Click the Find Match link in one of tables (Modifications table on the data validation results page, or one of the modifications table on the experiment details page). If you click this link for a structural modification you will see a page with buttons to find a Unimod Match or define a Combination Modification. Click the button to find a Unimod Match. This will display a page that shows the Unimod matches found for the modification based on the modification formula and modification sites (amino acids) and / or modified terminus. The option to define a combination modification is not available for Isotope modifications, so clicking the Find Match link will open the page with Unimod matches found for the modification.

If more than one match was found, click the Save Match button below the correct match to associate the Unimod Id with the modification.


Define a combination modification

Sometimes users have to create a custom modification in Skyline that is the combination of two modifications. Such modifications do not have a Unimod Id in the Skyline document. To associate a combination modification with the Unimod Ids of the two modifications that it combines, you can do the following:
  • Click the Find Match link in one of tables (Modifications table on the data validation results page, or the Structural Modifications table on the experiment details page). You will see the following page:


  • Click the button to define a Combination Modification. You will see a form where you can select two Unimod modifications that make up the modification.

  • Start typing the name of first modification in the textbox for Unimod Modification 1. The drop-down list will show you the modifications that match the text entered. Select a modification from the list.
  • The sum of the formulas of the two modifications you select must match the formula of combination modification. After you select the first modification, the form will update to show the difference in the formula of the combination modification and the selected modification.
  • Select the second modification in Unimod Modification 2. You can search for the modification by name or by the difference in the formula that is displayed in the form (e.g. H4C3O in the image above)


If the sum of the formulas of the two selected modifications matches the formula of the combination modification then a green checkmark will be displayed as shown in the image above.
  • Click the Save button.

The screenshot below shows a saved combination modification in the Modifications table on the data validation results page:

Clicking the Unimod Ids will link to the modification page on the Unimod website




Wildcard modifications in Skyline

Skyline includes the following built-in wildcard modifications.
  • Label:15N
  • Label:13C
  • Label:13C15N
These modifications implicitly apply to all amino acids. The Unimod modifications corresponding these modifications are included in Skyline's list of available isotope modifications. However, if you choose to use the wildcard modifications, the ProteomeXchange data validation process will automatically determine the correct Unimod modifications based on the amino acids in the peptides where the modification is applied. The matches found will be displayed in the Modifications table of the validation results page.




Download Data From Panorama Public



Download Skyline documents

Skyline documents available in a public dataset can be downloaded by clicking the download icon ( ) next to the document name. In the pop-up menu click Full Skyline Document. This will download a .sky.zip file which can be opened in Skyline.


Download raw data in a web-browser

Raw data uploaded with a dataset is available under the Raw Data tab in the top right corner. Click the tab to view a list of files available for downloading. Select one or more files and click the download icon ( ).


To select all the files listed in the files browser, select the first file in the list by clicking the name of the file in the File column. Press the Shift key and then select the last file by clicking the file name. This will select all the files between the first and the last selected files. Please note that this will not work if you use the checkboxes next to the file names to select files. Click files names instead to select files.

Download raw data using WebDAV

Files can also be downloaded using the WebDAV protocol. On Windows the raw data folder can be mapped as a network drive in Windows Explorer. Other WebDAV clients such as CyberDuck or WinSCP can also be used to connect to the folder.
In the Download Data panel below the files browser in the Raw Data tab you will find the WebDAV URL (example screenshot below) along with the email address and password that is needed to connect to the folder.



Map folder as a network drive in Windows

  • Copy the WebDAV URL displayed in the Download Data panel under the files browser in the Raw Data tab.
  • On your computer open Windows Explorer. Right-click This PC in the left pane and select Map network drive from the menu.


  • In the Map network drive dialog enter the WebDav URL copied in step 1. Check Connect using different credentials and click Finish.
  • When prompted for a username and password enter the email address and password from the DataPanel in the Raw Data tab and click OK.

This should map the folder as a network drive on your computer, and you should be able to copy down the desired files to another folder in Windows Explorer. Once you are done copying files you can disconnect the network drive by right-clicking the mapped drive and selecting Disconnect network drive from the menu. Please note that this works in Windows 10 and Windows Server 2016. If you have an older operating system and are unable to map a network drive with these steps then you can use a third party WebDAV clients such as CyberDuck and WinSCP.

CyberDuck (https://cyberduck.io/)

  • Click Open Connection.

  • In the Open Connection dialog select WebDAV (HTTPS) as the connection type.
  • In the Server field enter the WebDAV URL copied from the Download Data panel in the Raw Data tab. CyberDuck will automatically parse the URL and populate the Path field.
  • In the Username field enter public@proteinms.net.
  • In the Password field enter panorama.
  • Click Connect.



WinSCP (https://winscp.net/eng/index.php)

  • In the Login dialog select WwbDAV under File Protocol.
  • Copy the WebDAV URL in the Host name field. WinSCP will automatically parse the remote directory path from the URL, and you will only see "panoramaweb.org" in the field.
  • Enter public@proteinms.net under User name.
  • Enter panorama under Password.
  • Click Login.




For options on OSX and Linux see this link: Native OSX and Linux WebDAV Clients




Quality control with AutoQC


Panorama AutoQC

The Panorama AutoQC pipeline enables mass spec laboratories to evaluate LC MS/MS performance over time, and quickly identify potential issues. This pipeline comprises three components: Skyline, a Panorama server and AutoQC Loader, a utility program that automates the processing and uploading of QC results from the instrument computer to the Panorama server. The pipeline is initialized by specifying the following:
  • A template document with target QC peptides into which raw data files should be imported as they are acquired.
  • A local folder where QC results files are written.
  • A folder on the Panorama server where data should be uploaded.
After the Skyline documents containing QC results are uploaded to Panorama, users can examine instrument performance though a variety of charts that track several metrics such as retention time, peak area, FWHM etc. More information on the QC capabilities in Panorama can be found in the documentation links below.

Panorama QC folder documentation:


AutoQC Loader

AutoQC Loader automates the process of importing results files into a Skyline document and uploading the document to a folder on a Panorama server. It uses SkylineRunner to launch Skyline without showing the Skyline window. Command-line arguments are passed to this invisible instance of Skyline to import results files to a Skyline document and upload the document to the Panorama server specified in the settings.
Install AutoQC Loader
AutoQC Loader Documentation

AutoQC Setup Tutorial

A tutorial describing how to setup a Skyline document for use with AutoQC, and setting up the instrument method: AutoQC Setup



Lindsay Pino's AutoQC Setup Tutorial





AutoQC Loader Documentation


AutoQC Loader

AutoQC Loader automates the process of importing results files into a Skyline document and uploading the document to a folder on a Panorama server. It uses SkylineRunner or SkylineCmd to launch Skyline without showing the Skyline window. Command-line arguments are passed to this invisible instance of Skyline to import results files to a Skyline document and upload the document to the Panorama server specified in the settings. Install AutoQC Loader.


When you start AutoQC Loader for the first time you will see this window.



To start monitoring a local folder for QC results, create a new configuration by clicking the Add button. Each configuration is a combination of settings that include the location of the template Skyline document, the local folder where QC results will be written, and the folder on a Panorama server where the results will be uploaded. Multiple configurations can be enabled allowing users to monitor more than one QC data folder at the same time. Configurations are saved so that instrument operators can enable a previously created configuration if they are acquiring data for an ongoing project with intermittent breaks in data acquisition.

Configuration Settings

In the AutoQC Configuration form enter the appropriate settings in the Settings tab.



Configuration name: This can be the name of an instrument or the project or study for which data is being acquired. Each configuration has to have a unique name.

Skyline file path: This is the path to the template Skyline document into which QC results files will be imported. Click the browse button next to the textbox to open a Windows Explorer window and navigate to the template Skyline document (.sky file).



Note for Skyline versions prior to 4.2 the Integrate all setting (Settings > Integrate all) must be checked in the template Skyline document. This setting forced Skyline to calculate areas for all fragment ions between the integration boundaries and gives better quantitative results. Since Skyline 4.2 areas are now always the sum of all quantitative transitions, but you may still want this setting for visualization inside Skyline.

Folder to watch: This is the folder that AutoQC Loader will monitor for new QC results files. Any new results files added to the folder will automatically be imported into the given template Skyline document. When a configuration is started all existing results files in this folder that are newer than the last imported result in the Skyline document will get imported. If the document does not have any imported results, AutoQC Loader will import all the results files in the folder. The folder can be on a physical disk drive of the computer running AutoQC Loader, or it may also be on a mapped network drive, allowing central processing of system suitability files collected by multiple instruments.

File filter: This can be used to apply a filter on the results files that will be imported into the Skyline document. The default option (All) will import all results files added to the QC folder without applying any filters. Choose one of the other options from the drop-down list to import only those results files that match the filter. For example, the filter selected in the screenshot below can be used to import only those files that have the substring "_QC_" in the file name.



Results time window: The results time window determines how long imported results will be retained in the Skyline document. This is a rolling window and only results acquired within the last ‘n’ days, where ‘n’ is the width of this window in days, will be retained in the document. When a new run is imported into the document any results that no longer fall within this time window, ending on that day, will be removed from the document. The default (and minimum) width of the window is 31 days. Please note that AutoQC Loader does NOT delete any results files on the computer. Only results imported into the document that are older than the current time window are removed from the document. This is done to keep the active Skyline document from getting too large. The larger the document gets the more time it will take for each upload to Panorama. Uncheck the Remove Results checkbox to keep all the imported results in the Skyline document. This is not recommended for long-running projects.



Instrument type: The instrument type setting tells AutoQC Loader the type of files (e.g. *.raw for Thermo instruments, *.wiff for SCIEX instruments etc.) to look for in the folder that it is monitoring.

Expected acquisition duration: The expected acquisition duration determines how long AutoQC Loader will wait before attempting to import a new results file. Most instruments write directly to the output results file when data acquisition begins, and an error occurs if an attempt is made to read the file before acquisition is complete. When AutoQC Loader detects a new results file in the QC folder, it will wait for the duration specified in this setting before attempting to import the file. The default value for this setting is 75 minutes (10 min. trapping time + 60 min. gradient + 5 min. extra).

Panorama Settings

To upload the Skyline document containing QC results to a Panorama server, check the Publish to Panorama checkbox in the Panorama tab. Enter the URL of the Panorama server, your email and password on the server along with the path to the folder on the server where the document should be uploaded. AutoQC Loader will upload the document to the Panorama server each time a new results file is imported into the document.



The Panorama server manages redundant results files included in successive Skyline documents uploaded to a QC folder by keeping the results contained in the most recently uploaded Skyline document.

Note: The password is stored encrypted using a Windows system encryption key and is not accessible as plain text.

Skyline Settings

You can choose to use either Skyline or Skyline-daily with a configuration if both are installed on the computer that is running AutoQC Loader. This selection can be made in the Skyline tab of the AutoQC Configuration form. Only the installations of Skyline that are available will be enabled and selectable in the form. You may also specify the path to a Skyline (or Skyline-daily) installation somewhere else on your computer.




Running a Configuration

In the main AutoQC Loader window, in the Configurations tab check the box next to the configuration name to start the configuration. AutoQC Loader will start the monitoring the local folder specified in the configuration for new results files. Uncheck the box to stop the configuration.



The selected configuration can be edited by clicking the Edit button to the right of the Saved configurations panel.
To make a copy of the configuration, click the Copy button.
In addition, the following buttons are enabled when a configuration is selected in the Saved configurations list.


Exporting Configurations

You can export some or all of your saved configurations to a AutoQC Configuration file (.qcfg) by clicking the Share button in the main program window.


In the Share Configurations form select the configurations you want to export and click the Save button.


In the Windows File Explorer navigate to the folder where you want to save the file.

Configurations contained in the exported AutoQC Configuration file (.qcfg) can be imported into AutoQC Loader by clicking the Import button and selecting the .qcfg file in the File Explorer.

Invalid Configurations

Configurations that cannot be validated appear in red text in the list of configurations in the main window (e.g. "Fusion 1" in the screenshot below). Configurations can become invalid, for example, if the path to the Skyline document or the folder to monitor no longer exist on the computer. A configuration may also become invalid if the user email and password saved in the Panorama settings can no longer be authenticated, or if the permissions were changed on the Panorama server and the user does not have permissions to upload to the selected Panorama folder.



Attempting to run an invalid configuration will display an error message as can be seen in the example below where the path to the Skyline document does not exist on the computer.

To fix an invalid configuration either double-click the configuration name or select the configuration and click the Edit button. This will open the Configuration Set Up Manager which will step through the configuration issues which must be addressed to fix the configuration.


AutoQC Loader Settings



If you want AutoQC Loader to keep running continuously on your computer, and start-up automatically after the computer restarts check the Keep AutoQC Loader running checkbox in the Settings tab. This will place a shortcut to AutoQCStarter.exe in the Windows Startup folder. AutoQCStarter.exe checks every few minutes to see if AutoQC Loader is running, and starts it if it is not running. Any configurations that were running when AutoQC Loader was last running are also started.

Check the Minimize program to Windows System Tray to minimize the AutoQC Loader window to the Windows System Tray instead of the Task Bar. If the AutoQC icon is no longer visible in Windows System Tray, click the "Show hidden icons" button, and double-click the AutoQC icon to view the AutoQC Loader window.


Logging

AutoQC Loader writes to a log file (AutoQC.log) that is located in a directory with the same name as the name of the configuration. This directory can be found in the directory that contains the template Skyline document. You can open this directory by selecting a configuration and clicking the "Open Folder" icon shown below and selecting Log Folder.



The contents of the log can be viewed in the Log tab by selecting the configuration in the Configurations tab and clicking the View Log button. Once the Log tab is active you can also choose the log for any configuration from the dropdown list above the pane displaying the log text. The folder containing the log file for the selected configuration can also be opened by clicking the Open Folder button in the Log tab.

Please provide this log file to the developers if you run into any issues with AutoQC Loader.

Data Archival

AutoQC Loader creates a monthly archive (*.sky.zip) of the Skyline document. Archive creation is triggered when the first run is imported into the document in a given month. For example, when the first run is imported into the Skyline document, QC_doc.sky, in the month of August 2015, an archive file, QC_doc_2015_07.sky.zip, is created in the same directory as QC_doc.sky.




AutoQC Loader 1.1.0.20237 Documentation


This documentation is for an older version of AutoQC Loader. Please refer to the latest documentation here.

AutoQC Loader

AutoQC Loader automates the process of importing results files into a Skyline document and uploading the document to a folder on a Panorama server. It uses SkylineRunner to launch Skyline without showing the Skyline window. Command-line arguments are passed to this invisible instance of Skyline to import results files to a Skyline document and upload the document to the Panorama server specified in the settings.
Install AutoQC Loader for Skyline 3.5 or later, or Skyline-daily (3.1.1.8694 or later)

When AutoQC Loader starts up for the very first time, it will check for existing Skyline or Skyline-daily installations in the following order:

  • C:\Program Files\Skyline
  • C:\Program Files\Skyline-daily
  • Web installation (ClickOnce) of Skyline
  • Web installation (ClickOnce) of Skyline-daily
If an existing installation is found it is used for all future invocations of the program. The first two locations in the list above are the default locations for the Administrator Install of Skyline and Skyline-daily. Most users do not need an administrator install of Skyline, and install Skyline via the web-installer instead. The installation of Skyline or Skyline-daily that should be used by AutoQC Loader can also be configured in the Settings tab of the program window. Click the Apply button after making changes to the Skyline settings.




To start monitoring a local folder for QC results, create a new configuration in AutoQC Loader by clicking on the Create a new configuration button in the Configurations tab. Each configuration is a combination of settings that include the location of the template Skyline document, the local folder where QC results will be written, and the folder on a Panorama server where the results will be uploaded. Multiple configurations can be enabled allowing users to monitor more than one QC data folder at the same time. Configurations are saved so that instrument operators can enable a previously created configuration if they are acquiring data for an ongoing project with intermittent breaks in data acquisition.



Configuration Settings

In the AutoQC Configuration form enter the appropriate settings in the Settings tab.



Configuration name: This can be the name of the project or study for which data is being acquired.
Skyline file path: This is the path to the template Skyline document into which QC results files will be imported. Please note that the Integrate all setting (Settings > Integrate all) must be checked for Skyline documents that contain QC results. This setting forces Skyline to calculate areas for all fragment ions between the integration boundaries and gives better quantitative results.
Folder to watch: This is the folder that AutoQC Loader will monitor for new QC results files. Any new results files added to the folder will automatically be imported into the given template Skyline document. When a configuration is enabled or started, all existing results files in this folder that are newer than the last imported result in the Skyline document will get imported. If the document does not have any imported results, AutoQC Loader will import all the results files in the folder.
File filter: One of the options in this combo-box can be used to apply a filter on the QC files that will be imported to the Skyline document. Only files with names that match the selected option will be imported. The default option (All) will import all results files added to the QC folder without applying any filters.



Results time window: The results time window determines how long imported results will be retained in the Skyline document. This is a rolling window and only results acquired within the last ‘n’ days, where ‘n’ is the width of this window in days, will be retained in the document. When a new run is imported into the document any results that no longer fall within this time window, ending on that day, will be removed from the document. The default (and minimum) width of the window is 31 days. Please note that AutoQC Loader does NOT delete any results files on the computer. Only results imported into the document that are older than the current time window are removed from the document. This is done to keep the active Skyline document from getting too large.
Instrument type: The instrument type setting tells AutoQC Loader the type of files (e.g. *.raw for Thermo instruments, *.wiff for SCIEX instruments etc.) to look for in the folder that it is monitoring.
Expected acquisition duration: The expected acquisition duration determines how long AutoQC Loader will wait before attempting to import a new results file. Most instruments write directly to the output results file during acquisition, and an error occurs if an attempt is made to read the file before acquisition is complete. When AutoQC Loader detects a new results file in the QC folder, it will wait for the duration specified in this setting before attempting to import the file. The default value for this setting is 75 minutes (10 min. trapping time + 60 min. gradient + 5 min. extra).

Panorama Settings For a Configuration

To upload the Skyline document containing QC results to a Panorama server, check the Publish to Panorama checkbox in the Panorama Settings tab. Enter the URL of the Panorama server, your email and password on the server along with the path to the folder on the server where the document should be uploaded. AutoQC Loader will upload the document to the Panorama server each time a new results file is imported into the document.



The Panorama server manages redundant results files included in multiple, successive Skyline documents uploaded to a QC folder by keeping only the most recent copy of the results.


Starting or Stopping a Configuration

In the main AutoQC Loader window, under the Configurations check the box next to the configuration name to start the configuration. AutoQC Loader will start the monitoring the local folder specified in the configuration for new results files. Uncheck the box to stop the configuration.



AutoQC Loader Settings



If you want AutoQC Loader to keep running continuously on your computer, and start-up automatically after the computer restarts check the Keep AutoQC Loader running checkbox in the Settings tab. This will place a shortcut to AutoQCStarter.exe in the Windows Startup folder. AutoQCStarter.exe checks every few minutes to see if AutoQC Loader is running, and starts it if it is not running. Any configurations that were running when AutoQC Loader was last running are also started.

Check the Minimize program to Windows System Tray to minimize the AutoQC Loader window to the Windows System Tray instead of the Task Bar.

Logging

AutoQC Loader writes to a log file (AutoQC.log) in the directory that contains the template Skyline document. Please provide this log file to the developers if you run into any issues with AutoQC Loader.

Data Archival

AutoQC Loader creates a monthly archive (*.sky.zip) of the Skyline document. Archive creation is triggered when the first run is imported into the document in a given month. For example, when the first run is imported into the Skyline document, QC_doc.sky, in the month of August 2015, an archive file, QC_doc_2015_07.sky.zip, is created in the same directory as QC_doc.sky.



Recovering configurations for a broken installation


If your AutoQC Loader installation is broken and you are unable to install a new release over the top of your existing installation you may have to first uninstall AutoQC Loader on your computer and install it again. Before you uninstall AutoQC Loader, locate the file that contains the saved AutoQC Loader configurations. This file can be imported into your new installation to recover the configurations.

Finding and saving your settings:
On Windows 10, Windows 7 or Windows Vista, find the folder: C:\Users\<your_user_name>\AppData\Local\Apps\2.0
On Windows XP, it will be something like: C:\Documents and Settings\<your_user_name>\Local Settings\Apps\2.0
If you are unable to find either the AppData (Windows 10/7) or the Local Settings (Windows XP) folder, you may need to do the following in Windows Explorer:
  • Open the Folder Options form
    • On Windows 10, select the View tab and click Options > Change folder and search options.
    • On Windows 7, Windows Vista of Windows XP press Alt+T, O to open the Folder Options form.
  • Click the View tab.
  • Under the Hidden files and folders item, click the Show hidden files and folders option.
  • Click the OK button.
You should now be able to see the necessary folder in Windows Explorer.

With the Apps\2.0 folder open in Windows Explorer search for the file 'user.config'. You will likely find more than one. Look for the most recent file under a folder beginning with 'auto..'.
  • Open the file in a text editor to verify that it contains your configurations. AutoQC Loader configurations are saved as XML that will look like this:
<setting name="ConfigList" serializeAs="Xml">
<value>
<ConfigList>
<autoqc_config name=...>
<main_settings skyline_file_path=… />
<panorama_settings publish_to_panorama=… />
</autoqc_config>
</ConfigList>
</value>
</setting>
  • Save this file to another location on your computer (e.g. Desktop) and change the file extension from .config to .qcfg (e.g. user-config.qcfg). For versions of AutoQC Loader older than 21.1.0.158 change the extension from .config to .xml.
After you have a fresh installation of AutoQC Loader do the following to import the file
  • Click the Import button in the Configurations tab of the main window.
  • Select the .qcfg file saved in the previous step and click Open.
This should import your configurations.




Install Panorama


Panorama has been implemented as a module within LabKey Server, and is included in all official releases.
You can download the latest release of LabKey Server here for a new installation or to upgrade an existing one.  See LabKey installation documentation for available install options.

Once you have a running LabKey Server you can set up a workspace for your lab or group by creating projects and folders, and configuring user and group permissions for authenticated access to the workspace. Please see the LabKey documentation for:

For additional documentation and help regarding LabKey Server please visit the LabKey support site.

For information on creating folders in Panorama, see Create a folder in Panorama

For more information on getting your data into a Panorama server see Import data into Panorama.




Tutorials


Try one of these tutorials, and get hands-on experience using Panorama with real data.

Sharing Skyline Documents 

Panorama Chromatogram Libraries 

Submit Data to Panorama Public 

On Oct 20, 2015, the Skyline and Panorama Teams produced Webinar #11: Panorama Public and Panorama AutoQC, another great resource to learn more about some of the new aspects of Panorama.
[webinar]




Tutorial: Sharing Skyline Documents



Overview

Panorama is a freely available, open-source web server database application for targeted proteomics assays that integrates into a Skyline proteomics workflow. It has been implemented as a module within LabKey Server, an open-source bioinformatics data management platform with extensive support for proteomics data and a security model rich enough to support clinical studies.

Panorama can be installed by laboratories and organizations on their own servers. You can visit the LabKey Server installation documentation: https://www.labkey.org/wiki/home/Documentation/page.view?name=installServerDemo for the available installation options. For this tutorial you will use the Panorama server hosted at the University of Washington panoramaweb.org where users can request free projects and have full administrative rights to configure data organization and security. This tutorial is an introduction to Panorama and covers the following areas:

  • Requesting a project on panoramaweb.org
  • Data organization and folder management in Panorama
  • Publishing Skyline documents to Panorama
  • Data display options and searching results uploaded to Panorama
  • Providing access to collaborators and other groups

Getting Started

  • To start this tutorial, download the following ZIP file:
  • Extract the files in it to a folder on your computer, such as
    C:\Users\userName\Documents
  • This will create a new folder:
    C:\Users\userName\Documents\PanoramaSharing
It will contain all the files necessary for this tutorial.

Requesting a Project on panoramaweb.org

Open the Study9S_Site52_v3.sky file in Skyline either by double-clicking on the file in Windows Explorer or by going through the File > Open menu in Skyline. This file contains results that are part of a recent CPTAC multi-site SRM-MS system suitability study (Abbatiello et al., Mol. Cell. Proteomics 2013). The data in this document was collected at Site 52. To publish this document to Panorama, click on the Upload to Panorama button in the toolbar, as circled below. Alternatively, on the File menu, click Upload to Panorama.

Since you have not yet registered a Panorama server in Skyline, you will see the following message:

  • If you have an existing account on a Panorama server (or LabKey Server), and you would like to use that, click Continue and enter the server details in the Edit Server form Skyline presents. Skip to the next section of this tutorial.
  • If you do not have an existing Panorama account, click Register to request a project on the PanoramaWeb server hosted at the University of Washington. This will open the project sign-up page on panoramaweb.org in a web-browser as shown below.
  • Fill out the form and be sure to enter a Group name.
  • Click Submit for Review.
The group name is used to create projects on panoramaweb.org. The Panorama team reviews all project requests and, upon approval, creates a project with the requested group name. If you are looking for a space to work through this tutorial and explore Panorama, please enter "Tutorials" in the Group name, and a folder with full administrative rights will be created for you in the Tutorials project on panoramaweb.org. Otherwise, enter your preferred project name. Once your project or folder has been created, you will receive a welcoming email with a link to setup a password for your account. After you have completed the registration process you can sign-in to panoramaweb.org. On the home page, click the Projects tab to see a list of all the projects to which you have access on panoramaweb.org. If you entered "Tutorials" in the project sign-up form, you will see the Tutorials project where a folder was just created for you.

Click on the Tutorials project to go to the project homepage. On the project homepage, hover over the project name in the menu bar below the Panorama icon, click the to open the Tutorials node, then click on the folder that was created for you (e.g. ‘Your_Username’ in the following screenshot). You will have full administrative rights in your folder, so you will be able to create a folder structure for organizing your Skyline documents, and configure user access to the sub-folders.

Creating a Subfolder in Panorama

Skyline documents cannot be uploaded to the root project folder on panoramaweb.org or your folder in the ‘Tutorials’ project. You will create a sub-folder for uploading the Skyline document that you opened earlier. As a project administrator, you would typically organize your project workspace to have subfolders for each project and/or each researcher in your laboratory or organization. Follow these steps to create a "system suitability" sub-folder in your folder in the “Tutorials” project:

  • Navigate to "Your_Username" folder home page, if you are not already there.
  • Hover over the project name in the menu bar below the Panorama icon and click on the new folder icon shown in the image below.
  • In the Create Folder form, enter "system suitability" in the folder Name field.
  • Select the Panorama option under Folder Type. This is the folder type that should be selected for all workflows supported by Skyline (SRM-MS, MS1 filtering or MS2 based projects).
  • Click Next.
  • On the "Users / Permissions" page accept the default selection and click Next. You will configure user permissions on this folder later.
  • The next page Configure Panorama Folder asks you to choose the type of Targeted MS folder you would like to create. Panorama offers three choices here. For this tutorial accept the default Experimental data option. This option is meant for folders that serve as a repository of Skyline documents, useful for collaborating, sharing and searching across multiple experiments.
  • Click Finish.

You will be taken to the home page of the "system suitability" sub-folder that should look as follows:

You are now ready to upload Skyline documents to this folder.

Publishing Data from Skyline to Panorama

To publish your first Skyline document to PanoramaWeb, perform the following steps:

  • Open "Study9S_Site52_v3.sky" in Skyline if it is not already open.
  • If the Edit Server form is not already open, open it by clicking the Upload to Panorama button, or selecting File > Upload to Panorama and clicking Continue in the popup.
  • In the Edit Server form, enter the email address and password for your account.
    • If you are using PanoramaWeb, the server URL should already be entered as https://panoramaweb.org.
    • If not, enter the URL to your Panorama/LabKey Server.
  • Click OK.
Skyline will now display a form with the folder hierarchy on panoramaweb.org. Only the folders to which you have access will be displayed.
  • Navigate to and select the "system suitability" folder.
  • Click OK.

Skyline will create a ZIP archive of the files for your document and upload the ZIP file to panoramaweb.org, where it will be imported into the Panorama database.

A popup message reading "Publish succeeded, would you like to view the file in Panorama?" will appear. Click Yes to view the document details.

Viewing Data in Panorama

If you are not already viewing the document details, return to your "system suitability" folder, refresh the browser window if necessary, and click the name of the file you just uploaded in the Targeted MS Runs box.

The Document Summary box shown in image below gives you a summary of the number of proteins, peptides, and transitions in your document.

Below the Document Summary box you can view a list of all the proteins, peptides and precursors in your document, along with some of the information imported from the Skyline document, such as a modified peptide sequence, m/z and charge. You can click on a protein or peptide to view more details, including chromatograms and some of the other graphs that are also available in Skyline. Scroll down on the page and click on the peptide CAVVDVPFGGAK. This will take you to a page that has the following details for this peptide:

1. Chromatograms to show quantitative data quality

This peptide was measured in 10 QC system suitability replicates and there were 3 blank acquisitions. On this page you can view the chromatograms for this peptide in all the replicates. The image below shows the precursor and transition chromatograms in the replicates QC_01 and QC_02. There is one row of chromatograms for each replicate in your Skyline document, where the first column has the total precursor chromatogram and the subsequent columns have transition chromatograms. If this precursor was measured in a light as well as a heavy-labeled from, transition chromatograms for both the forms would be displayed side-by-side.

2. Peak Area Replicate Graph

Scroll further down on the page or collapse the Chromatograms box by clicking on the icon in the header of the box as circled in the image above.

In the Summary Charts panel, you will now see a graph displaying the peak area for this peptide in the 13 replicates. This graph is similar to what you would see in Skyline for this peptide.

As in Skyline, Panorama also allows grouping peak areas by custom replicate annotations. In this Skyline document researchers used a custom "system suitability" annotation that was set to "true" for the system suitability replicates and "false" for the blank acquisitions. You can group the peak areas by selecting "system suitability" from the pull-down combo-box next to Group By.

Click Update to see peak areas grouped by the "system suitability" annotation.

In the graph above, the red bar labeled ‘true’ represents the 10 system suitability runs, and the small error bar indicates that there was very little variability in the measurements for this peptide in the 10 replicates. You can also switch to a Coefficient of Variation (CV) view by checking the CV Values box and clicking Update again.

3. Library MS/MS spectrum viewer

Scroll down further on the peptide details page to see an interactive spectrum viewer displaying the MS/MS spectrum for CAVVDVPFGGAK from the spectrum library associated with this Skyline document. The name of the library is displayed in the title bar of the viewer. The viewer allows you to zoom in by clicking and dragging your mouse over the spectrum. You can also customize the view by selecting the ion types and charge states you want to display from the options menu to the left of the spectrum. A color-coded table to the right of the spectrum lists all the fragment ion m/z values for the peptide, with colored boxed representing the matching fragment ions found in the library spectrum. These spectral library views can be used to support publications in peer-reviewed journals or share data with collaborators.

Customizing Grid Views in Panorama

On your web-browser click the back button, or scroll to the top of the page and click on the ZIP file name in the navigation trail just under your folder name as shown in the image below. This will take you back to the documents details page.

LabKey Server, on top of which Panorama is built, allows customizations of all tabular views. You can select which columns you would like to see, order them according to your preference, and define a sorting order. The Precursor List table on this page has blank annotation columns since the researchers did not define any custom peptide or precursor annotations in this Skyline document.

To hide these columns from the default view preform the following steps:

  • Select (Grid Views) just under the Precursor List heading.
  • Choose Customize Grid from the drop-down menu.

In the customization form that appears, you will see the Selected Fields panel on the right that shows the fields that are currently displayed.

  • Hover over "Peptide Note/Annotations" below Peptide in the Selected Fields and click the (remove) icon.
  • Do the same for "Precursor Note/Annotations" below Precursor.
  • Click Save.
  • In the popup, leave "Default grid view for this page" checked.
  • Check "Make this grid view available to all users". This will cause all users with access to this folder to see the same table columns.
  • Click Save.

The annotation columns should no longer be displayed, as shown below:

You can view the LabKey Server documentation on customizing grid views (https://www.labkey.org/wiki/home/Documentation/page.view?name=customViews) for more information.

Downloading Skyline Files from Panorama

Scroll up, if you need to, to view the Document Summary box. You can download the original Skyline ZIP archive that was published to Panorama by clicking on the Download link next to the file name.

To open this zip file in Skyline do the following:

  • On the File menu, click Open (Ctrl-O).
  • Navigate to and select the zip file that you downloaded.
  • Click the Open button.

Publishing to Panorama provides a convenient way to share Skyline documents with other researchers. You will see later in this tutorial how to give other users access to the folders you create in Panorama.

Uploading Documents Using the Panorama Web Interface

Using the Skyline Publish to Panorama toolbar button or menu item is the most convenient way to get your documents into Panorama. But this can also be done by using the Panorama web interface. Next, you will use the web-interface to upload another document to the "system suitability" folder.

  • In Skyline, open the file "Study9S_Site54_v2.sky".
This file contains results acquired at another site in the CPTAC system suitability study. Prepare this file for upload to Panorama by doing the following:
  • In the File menu, click Share.
  • Click the Minimal button in the form that appears.
  • Save the ZIP file on your computer using the Share Document form presented by Skyline.
  • In Panorama, go to the "system suitability" folder.
  • Click the Data Pipeline tab in the upper right corner.
  • Click Process and Import Data as shown below.
  • In the Files browser, click Upload Files.
  • Click Browse or Choose File.
  • Select "Study9S_Site54_v2.zip" that you just saved through Skyline.
  • In the Description field enter "Site 54".
  • Click Upload.

Once the file has been uploaded it will appear in the list of files in your folder.

  • Check the box next to Study9S_Site54_v2.zip.
  • Click Import Data in the toolbar.
  • Confirm that Import Skyline Results is selected.
  • Click Import in the Import Data popup.
Wait for the file import to complete and then click the Panorama Dashboard tab. You will now see 2 files (from sites 52 and 54) available under Targeted MS Runs.

Search Features in Panorama

Panorama allows you to search for proteins, peptides and even peptides with specific modifications across all the documents contained in a folder and its sub-folders. These search features are particularly useful for large projects and data sets, and help to compare results between data acquired over a long period of time.

On the "system suitability" folder page look at the Mass Spec Search box. You will see three available search options under the tabs Protein Search, Peptide Search and Modification Search. You will use the modification search option later in the tutorial. To perform a peptide search do the following:

  • Click the Peptide Search tab.
  • Enter "GFCGLSQPK" in the Peptide sequence field.
  • Check Exact matches only.
  • Click the Search button.

On the results page, in the Targeted MS Peptides box, you will see a list of documents in your folder where this peptide was observed. This peptide was found in both documents uploaded (sites 52 and 54) to this folder. You can view the details for the peptide in a document by clicking on the peptide sequence.

Sharing Data in Panorama

Panorama allows you to set fine-grained access control on your folders. You can grant access to your folders to individual collaborators or groups of researchers, and you can also configure the type of access (read-only, read and edit etc.).

To change the permissions on the "system suitability" folder, first, make sure that you are on the "system suitability" folder page. If not, return by hovering over your project name (e.g. Tutorials) in the menu bar below the Panorama icon, opening the project and folders, then clicking your "system suitability" folder as shown in the image below.

To change the permissions on this folder, navigate to the Permissions page by doing the following:

  • On the menu bar, choose (Admin) > Folder > Permissions.

If you did not configure the permissions for this folder during the folder creation process, the permissions page should look like this.

The email address selected for the Folder Administrator role should be the email address with which you requested a project on panoramaweb.org. The Folder Administrator has full control over a folder. To add Brendan MacLean (Skyline team) to the Editor role, which will give him the ability to add and delete documents to this folder, follow these steps:

  • Uncheck "Inherit permissions from parent", if it is checked.
  • Select ‘brendanx@uw.edu (Brendan MacLean)’ from the combo-box next to Editor.
  • Click Save.
To add Vagisha Sharma (Panorama team) to the Reader role:
  • Select ‘vsharma@uw.edu’ from the combo-box next to Reader.
  • Click Save.
The Reader role allows users to view data in a folder but they may not add or delete documents. The permissions page should now look like this:

Instead of adding individual users to a role you can create a group of users and assign a role to the group. Only Project Administrators have permissions to create user groups. If you are working in your folder in the “Tutorials” project on panoramaweb.org, you do not have project administrator privileges. However, if you are working through this tutorial in your own project on panoramaweb.org or any other Panorama server, follow these steps to create a "Seattle collaborators" group and assign it to the Reader role:

  • On the Permissions page click on the Project Groups tab.
  • In the New group name field enter "Seattle collaborators" and click Create New Group.
  • In the popup select Brendan and Vagisha from the pull down list to add them to the group.
  • Click Done.
  • Select the Permissions tab.
  • Add the new "Seattle collaborator" group to the Reader role.
  • Click Save.
  • Select your "system suitability" folder in the folder navigation column.
  • Add the "Seattle collaborator" group to the Reader role for this folder.
  • Click Save and Finish.
Members of the "Seattle collaborators" group will be able to view the "system suitability" folder if they have a direct link to the folder. They will not be able to view the parent folder (e.g. Your_Username) on the home page or navigate to the "system suitability" folder through the folder navigation UI. To access a folder from the UI, users or user groups require read permissions not only on the folder but also on the parent folders all the way up to the root project folder. To enable the "Seattle collaborators" group to access the "system suitability" folder via the navigation UI, assign the Reader role to this group in the parent folder (e.g. Your_Username).

You can add more users later to the "Seattle collaborators" group. All users in this group will have read access to the "system suitability" folder. If you would like to add a user to the "Seattle collaborators" group that does not already have an account on Panorama, you can do that by following these steps:

  • Select (Admin) > Folder > Permissions.
  • Click the Project Groups tab.
  • Click the "Seattle collaborators" group.
  • In the popup, click Manage Group.
  • On the Manage Group page, enter the email address of the new user in the Add New Members field.
  • Scroll down and click Update Group Membership.
An email will be sent to the new user and they will be able login to view the data in the "System suitability" folder once they setup a password for their account.

You can view the LabKey Server documentation on configuring permissions (https://www.labkey.org/wiki/home/Documentation/page.view?name=configuringPerms) for more information.

Viewing of PTM-containing Peptides in Panorama

Many journals require visual display of MS/MS spectra of peptides containing post-translational modifications such as phosphorylation or acetylation. You can make use of Skyline to build spectral libraries from your peptide search results and view the annotated spectra in the Skyline Spectral Library Explorer. However, using the resulting Skyline document to satisfy journal requirements requires that you send the Skyline document to reviewers, and that they have a local installation of Skyline to view the document. Alternatively, you can publish the documents to Panorama, where reviewers can view the spectra in the Panorama spectrum viewer.

Next, you will import a Skyline document to Panorama that contains phosphorylated peptides, search for modified peptides and view their spectra.

Create a new sub-folder in "Your_Username" folder called "Phospho peptides", using another method for creating sub-folders in Panorama than you used before:

  • In the header bar, select (Admin) > Folder > Management.
  • On the Folder Management page, make sure that the Folder Tree tab is selected, and "Your_Username" folder is highlighted.
  • Click Create Subfolder.
  • In the Create Folder wizard enter Name: “Phospho peptides”.
  • Select Folder Type, "Panorama" as before.
  • Click Next.
  • For Users/Permissions keep the default selection: Inherit from Parent Folder.
  • Click Next.
  • Select Experimental Data on the Configure Panorama Folder page.
  • Click Finish.
To add to the new folder a Skyline document containing a spectral library from a phosphorylation experiment, perform the following steps:
  • In Skyline, open the file "Phospho_0921_2010_Thr99_v1_P only.sky" from the tutorial folder.
  • Click the Publish to Panorama toolbar button.
  • Select the “Phospho peptides” folder from the folder tree in the Publish Document dialog.
  • Click OK.

Wait for data import to complete and then go back to Panorama in your web-browser, and navigate to the “Phospho peptides” folder. Refresh the page (F5 in most browsers) if you are already on the “Phospho peptides” folder page. You should see the file that you just imported to Panorama in the Targeted MS Runs table. Click on the name of the file to see the document details. Clicking on any of the peptide sequences will take you to the peptide details page where you can view the library spectrum for the peptide. Click the back button to go back to the folder page, or use the Phospho peptides link.

To find all peptides in this document containing a phosphorylation, perform the following steps:

  • In the Mass Spec Search box, select the Modification Search tab.
  • Choose the Delta Mass option for Search By, if it is not already selected.
  • Enter "S" in the Amino Acid field.
  • Enter "80" in the Delta Mass field.
  • Click Search.

You will now see a list of all the serine phosphorylated peptides in the document. Click on the first peptide in the list, LSVPTSDEEDEVPAPKPR, to view its library spectrum. Click back in your browser. In the Peptide Summary box click on the name of the protein (sp|Q8NE71|ABCF1_HUMAN) to which this peptide belongs.

You will be taken to the protein details page where you can see the location of this peptide in the protein sequence.

Conclusion

In this tutorial, you have been introduced to new ways you can share Skyline documents with collaborators, reviewers and the general public using Panorama, and the PanoramaWeb.org web site hosted by the MacCoss Lab at the University of Washington. You have requested a project on PanoramaWeb, registered an administrator account for that project with your email address, and created 2 new folders in that project. You have explored data from Skyline documents in these folders, searched for specific peptides and post-translational modifications, and customized access to the data in them. If you worked on this tutorial in your own project instead of the "Tutorials" project, you can now just as easily go back to the folder management form and delete these tutorial folders to return your new project to its original state, ready for your own experimental data.

We wish you luck in your research and hope that you find these tools useful in sharing and disseminating your findings.




Tutorial: Panorama Chromatogram Libraries


Overview

Targeted assay development for proteins or peptides is typically a time-consuming and lengthy process. Deciding the ideal set of peptides and transitions to measure for your proteins of interest requires careful experimental design and iterative optimization. Once an assay has been established, the assay parameters can be reused for designing future experiments. Chromatogram libraries in Panorama provide a way you can store targeted assays that have been curated in Skyline and reuse them in the future for measuring proteins and peptides in other samples, as well as share them with other researchers. Chromatogram libraries can also capture physiochemical and experimental properties such as the relative ion abundance, measured retention time, measured chromatograms, and in the future we expect to store iRT, ion mobility, and optimal instrument parameters such as collision energy. Empirical measurements for these parameters can be particularly relevant in guiding targeted experiment design.

You can preview the results of this tutorial in an example folder on PanoramaWeb.org.

In this tutorial we will:

  • Create a folder in Panorama for chromatogram library data.
  • Add Skyline documents, with curated targeted results, to the chromatogram library folder.
  • Download the chromatogram library from Panorama and use it in Skyline.

Getting Started

To start this tutorial, download the following ZIP file:

Extract the files to a folder on your computer, like:
C:\Users\username\Documents

This will create a new folder:

C:\Users\username\Documents\PanoramaChromatogramLibraries

It will contain all the files necessary for this tutorial.

The data used in this tutorial was published in Stergachis et al. 2011, where the authors described a high-throughput method for selecting optimal peptides and fragment ions for targeted proteomics applications. The Skyline files used in this tutorial contain assays for a subset of the 96 human transcription factors on which they demonstrated their approach.

Signing Up for an Account on panoramaweb.org

This tutorial assumes that you will be working in a sub-folder of the "Tutorials" project on panoramaweb.org, the Panorama server hosted by the MacCoss lab at the University of Washington. However, if you already have an existing account and project on panoramaweb.org, or have an account on another Panorama server you are welcome to use that, and skip to the next step.

To request a folder on panoramaweb.org for working through this tutorial, fill out the sign-up form on this page: https://panoramaweb.org/labkey/wiki/home/support/page.view?name=hosted-project-signup-form

  • Fill in the required fields, marked with a red asterisk, in the form shown below.
  • Enter "Tutorials" in the Group name.
  • Click Submit.

Once your request is approved, a folder with full administrative rights will be created for you in the "Tutorials" project on panoramaweb.org. You will receive a welcoming email with a link to complete your account registration by choosing a password.

Creating a Chromatogram Library Folder in Panorama

First sign in to the Panorama server and navigate to your folder. If you are working in the "Tutorials" project on panoramaweb.org follow these steps:

  • Click the Projects tab to see a list of all the projects to which you have access on the server.
  • Click the "Tutorials" project.
  • On the project homepage, hover over the project name in the menu bar below the Panorama icon and click on the folder that was created for you (e.g. "Your_Username").

When organizing your data for chromatogram libraries, we recommend that you create a folder for each species that you study, and under each species folder you can create subfolders for the instrument type where the data was collected, or any other experimental conditions for which it is appropriate to have separate chromatogram libraries. In this tutorial you will create a subfolder for building a chromatogram library for human transcription factors. To create a sub-folder for this tutorial, do the following:

  • Hover over the project menu and click the new folder icon shown in the image below.
  • In the Create Folder form, enter "Human" in the folder Name field.
  • Select the Panorama option under Folder Type, as shown below.
  • Click Next.
  • On the Users / Permissions page accept the default selection.
  • Click Next.
  • On the Configure Panorama Folder page choose the Chromatogram library option.
  • Check the box to "Rank peptides within proteins by peak area".
  • Click Finish.
The Rank peptides within proteins by peak area box should be checked when you have targeted results containing relative peptide peak areas for a given protein. Leave this box unchecked if you do not yet have quantitative data from proteolytically digested proteins, such as when you are working with synthetic peptides.

After successful folder creation, you will be taken to the home page of the "Human" chromatogram library folder that should look as follows:

You are now ready to upload Skyline documents to this folder.

Publishing Skyline Documents to a Library Folder in Panorama

Open the "Stergachis-SupplementaryData_2_a.sky" file in Skyline either by double-clicking on the file in Windows Explorer or in Skyline, on the File menu, click Open (Ctrl-O). This file contains peptides and fragment ions for 10 human transcription factors published in Stergachis et al. 2011. To publish this document to your library folder on Panorama, follow these steps:

  • Click on the Publish to Panorama button in the Skyline toolbar, shown in the image below. Alternatively, on the File menu, click Publish to Panorama.

If you have not yet set up a Panorama server in Skyline, you will see the following message.

  • Click Continue.
In the Edit Server form that appears, the default value in the URL field is https://panoramaweb.org. This is the URL of the server hosted at the University of Washington, and the server where you have an account if you followed the registration steps at the beginning of this tutorial.
    • If you are working on a server other than panoramaweb.org, enter the URL of your server.
    • Enter your email address and password on the Panorama server.
    • Click the OK button.
Skyline will now display a form with the folders available to you on your Panorama server. Chromatogram library folders will have the chromatogram icon next to them.

  • Navigate to and select the "Human" folder that you just created in Panorama.
  • Click the OK button.
Skyline will upload a ZIP archive of your document to the selected library folder on the Panorama server.

Viewing Chromatogram Library Data in Panorama

Once your document has been imported into Panorama, go back to the web-browser where the home page of the "Human" library folder should still be open. Skyline will offer you the option to directly view the results. From this page click Human to return to the home page. Refresh the page (F5 in most browsers) and, in the Chromatogram Library Download box, you will see that the first version (Revision 1) of your "Human Library" is now available for download. A brief summary of the contents of the library is also displayed under the Library Statistics heading.

Further down on the page, in the Mass Spec Search box, you can search for proteins, peptide sequences or peptides with specific modifications in your library.

The tables below the Mass Spec Search box display a list of the proteins and peptides in the library folder. Clicking on an entry in one of these tables will display more details for the selected protein or peptide. Click on CTCF in the Proteins table to bring up a page with more details for this protein. The Sequence Coverage box displays the sequence, with colored rectangles highlighting the peptides for which there are measurements in the library.

The Peptides table displays a list of these peptides along with some information that was contained in the uploaded Skyline document, such as the retention time.

Below the Peptides table is a bar graph that displays the peak areas of the peptides, ordered from the highest to the lowest measured peak area. Retention times are also shown.

Go back to the home page of your library folder either by clicking your browser's back button or by clicking the Human (folder name) link near the top of the page.

Updating Chromatogram Libraries

As you develop assays for more proteins or peptides, you can publish Skyline documents containing those assays to the same library folder. Panorama will build a new version of the library each time a Skyline document is published to the folder. Any proteins that were not already included in the library will be added.

Open the file "Stergachis-SupplementaryData_2_b.sky" in Skyline. This file contains another subset of transcription factor assays from "Stergachis et al. 2011|#reference]. This file also contains measurements for the transcription factor MAX that was already included in the first document that you published to the library folder. Two additional peptide measurements are included for this protein in this document.

Publish this document to the "Human" chromatogram library folder on Panorama by doing the following:

  • Click the Publish to Panorama button in the Skyline toolbar.
  • Select the "Human" folder in the Panorama Folders tree of the Publish Document form.
  • Click OK.
  • Wait for the file import to complete.
  • Go to your browser and refresh the library folder page on PanoramaWeb. If you click Yes in Skyline to "view the file in Panorama", you will open a new browser showing the results. Click Human near the top of the page to return to the library folder page.
You will see that a new version of the library is now available in Panorama, as indicated by the higher revision number (2) in the Chromatogram Library Download box. This library includes the new proteins, peptides and transitions from the Skyline file that you just uploaded, reflected in the updated library statistics. You should also see a warning message below the library statistics about a conflicting protein. This message is displayed because the document you just uploaded contains a protein (transcription factor MAX) which already existed in the library.

In case of a conflict, Panorama marks the incoming version of the protein as conflicted, and continues to include the older version of the protein in the library, until the conflict is resolved. The library built after uploading "Stergachis-SupplementaryData_2_b.sky" still contains peptides, transitions and chromatograms for protein MAX from the first document that was uploaded to the library folder. To tell Panorama to use the newer version of the protein:

  • Click the Resolve conflicts link.
You will now see a table containing a list of conflicting proteins displayed side by side. The left column, titled Conflicting Proteins in Document, displays the version of the protein contained in the document that you just uploaded. The right column, titled Current Library Proteins has the version contained in the current library.

Click on the (plus) icon next to the protein name to view the list of peptides measured for this protein in the two versions. (When expanded, the icon will become a (minus). The new document contains measurements for two additional peptides that are marked in the image below.

To resolve this conflict by choosing the new version of the protein, do the following:

  • Under Conflicting Proteins in Document, click the check box next to the protein name if it is not already checked.
  • Click Apply Changes.
Panorama will now rebuild the library and include the new version of the protein with all its peptides and transitions. Any peptides or transitions that existed only in the older version of the protein will be removed from the library. Once the new library has been built you will be taken to the home page of the library folder where you will see that a new revision (3) of the library is available. The conflict message should no longer be displayed.
  • Click on the Download button and save the chromatogram library file (Human_rev3.clib) to your computer.
You will use this library in the next section of the tutorial.

You can access older revisions of the library by clicking on the Archived Revisions link below the library file name, shown in the image below.

A table with all the library revisions will be displayed. You can download older revisions by clicking on a file name in the Archived Revisions table.

Using Chromatogram Libraries in Skyline

You will now prepare a new Skyline document to measure the proteins CTCF and MAX in another sample. The library you just downloaded from Panorama contains chromatograms for peptides from these proteins. You will use the library to filter the set of peptides and transitions in your Skyline document to the best responding ones contained in the library. You will also see how you can compare fragment ion or transition chromatograms obtained in a new experiment with chromatograms contained in the library to confirm peptide identifications.

Before you begin, make sure that the peptide and transition settings in Skyline are configured correctly, by creating a new file and adjusting its settings as necessary:

  • On the File menu in Skyline, click New (Ctrl-N).
Configure the peptide settings as follows:
  • On the Settings menu, click Peptide Settings....
  • Click the Digestion tab, if it is not already selected.
    • In the Enzyme dropdown list, select "Trypsin KR " (if it is not selected by default).
    • In the Max Missed Cleavages dropdown list, select "0" (if it is not selected by default).
    • In the Background proteome dropdown list, select "None" (if it is not already selected).
  • Click the Filter tab.
    • In the Min length field, enter "7".
    • In the Max length field, enter "23".
    • In the Exclude N-terminal AAs field, enter "0".
    • Uncheck Exclude potential ragged ends (if it is checked).
    • Uncheck any selected options in the Exclude peptides containing: list.
    • Check Auto-select all matching peptides (if it is not already checked).
  • Click the Library tab.
    • Uncheck any selected libraries.
  • Click on the Modifications tab.
    • Check the "Carbamidomethyl (C)" modification in the Structural modifications list (if it is not already checked).
    • Uncheck any other selected modifications in the Structural modifications list.
    • Uncheck any selected modifications in the Isotope modifications list.
  • Click the OK button in the Peptide Settings form.
Configure the transition settings as follows:
  • On the Settings menu, click Transition Settings....
  • Click the Filter tab.
    • In the Precursor charges field, enter "2".
    • In the Ion charges field, enter "1".
    • In the Ion types field, enter "y".
    • In the Product ions section From dropdown list, select "ion 3".
    • In the Product ions section To dropdown list, select "last ion – 1".
    • In the Special ions list, uncheck any selected options.
    • Make sure that the Precursor m/z exclusion window field is blank.
    • Check Auto-select all matching transitions (if it is not already checked).
  • Click on the Library tab.
    • Uncheck If a library spectrum is available, pick its most intense ions.
  • Click on the Instrument tab.
    • Enter "50" in the Min m/z textbox.
    • Enter "1500" in the Max m/z textbox.
    • Uncheck Dynamic min product m/z if it is checked.
  • Click the OK button in the Transition Settings form.
The files you downloaded for this tutorial include the file "CTCF_MAX.txt". This file contains sequences for the proteins CTCF and MAX. To add these proteins to the new Skyline document do the following:
  • On the File menu, choose Import and click FASTA....
  • Browse to and select "CTCF_MAX.txt" in the file browser.
  • Click the Open button.
The Skyline window should now look like this:

The settings you configured in Skyline have resulted in 31 peptides for the two proteins. If you export a transition list for this document without applying any filtering you would be measuring 220 transitions. However, you can take advantage of the information contained in the chromatogram library to limit your measurements to the best responding precursors and product ions for the two proteins. Follow these steps to filter the list of peptides and transitions:

  • On the Settings menu, click Peptide Settings....
  • Click the Library tab.
  • Click the Edit List button.
  • Click the Add... button in the Edit Libraries form.
  • In the Name field of the Edit Library form, enter "Panorama Human Library".
  • Click on the Browse... button.
  • Select the "Human_rev3.clib" chromatogram library file that you downloaded earlier.
  • Click the OK button in the Edit Library form.
  • Click the OK button in the Edit Libraries form.
  • Check the box next to "Panorama Human Library", in the Libraries list.
  • In the Pick peptides matching dropdown list that appears, select Library (if it is not selected by default).
  • In the Rank peptides by dropdown list, select Peak Area.
  • Check the Limit peptides per protein box.
  • In the Peptides field, enter "5".
The Peptide Settings form should now look like this:

  • Click the OK button.
The number of transitions in the document should have decreased from 220 to 64. Skyline also displays a rank for each peptide as indicated in the image below. This rank is based on the total peak area, summing all transition peak areas, for the peptide in the library.

This number can be further reduced by limiting the transitions to the top ranking transitions in the library.

  • On the Settings menu, click Transition Settings....
  • Click the Library tab.
  • Check the box for If a library spectrum is available, pick its most intense ions.
  • In the Pick: product ions field that appears, Enter "3".
  • Select the From filtered product ions option.
The Transition Settings form should look like this:

  • Click the OK button.
The number of transitions in this document should now be 30.

You can now export a transition list or a native instrument method for this document, and acquire data. Skyline offers the ability to export transition lists and SRM methods for instruments from several different instrument manufacturers.

  • On the File menu, choose Export and click either Transition List... or Method....
  • To view the list of supported instrument types, use the Instrument type dropdown menu.
Please see the Targeted Method Editing and Targeted Method Refinement Skyline tutorials for more information on exporting transition lists and SRM Methods.

The files you downloaded for this tutorial already contain a document with data acquired on a triple quadrupole mass spectrometer. To begin exploring how acquired data and your new chromatogram library can be used together:

  • Open the file "In_vivo_versus_in_vitro_comparison.sky" in Skyline.
  • In the Targets view, select the peptide "TFQCELCSYTCPR", under the CTCF protein.
The Skyline window should look like this:

You should see the chromatograms for this peptide from the newly acquired data side-by-side with the chromatograms from the Human_rev3.clib library. The tab titled K562 (nuclear) has the chromatograms from the new data, and the tab titled Library Match displays the library chromatograms.

If you do not see the Library Match tab you can display it as follows:

  • On the View menu, click Library Match.
Skyline also calculates a dot product as a measure of similarity between the peak areas in the new data and the library peak areas. This is displayed next to the precursor, as marked in the image above. For the peptide TFQCELCSYTCPR the similarity is high, with a dot product of 0.97, and that gives a measure of confidence in the peptide identification.

Conclusion

In this tutorial, you have gone through the steps of creating a library folder in Panorama for curated, targeted results. You have built a chromatogram library in Panorama, and used it in Skyline to select the peptides and product ions to measure in a new experimental setting. You have also compared chromatograms acquired in a new experiment with data contained in the library to validate peptide identifications. By using these techniques with your own experimental data, you can build an extensive knowledge base of the targeted assays you have investigated and refined in your laboratory, and avoid duplicating this effort in new experiments. You can share these libraries with collaborators or the general public, as others are already doing, helping others to reproduce your results, or use them for new applications in targeted proteomics.

Reference List

1. Stergachis, A., MacLean, B., Lee, K., Stamatoyannopoulos, J. A., & MacCoss, M. J., Rapid empirical discovery of optimal peptides for targeted proteomics Nature Methods 8,1041–1043 (2011)

Related Topics




Tutorial: Submitting Supplementary Data to Panorama Public


Overview

PanoramaWeb (https://panoramaweb.org), the public Panorama server hosted at the University of Washington is being increasingly used by researchers to host data processed in Skyline for sharing with collaborators and for referencing in published papers. Users on PanoramaWeb are given their own projects over which they have full administrative control. The ease of uploading Skyline documents to Panorama combined with the ability to configure permissions and folder structure makes PanoramaWeb an attractive choice for hosting and sharing data from Skyline centric workflows. It also makes it possible for users to provide public access to data for fulfilling journal submission requirements. Several papers have already been published that reference supplementary Skyline documents hosted on PanoramaWeb. However, data in user projects remains under the control of the user, and may be edited or deleted post publication.

To address this concern, PanoramaWeb hosts a public repository called "Panorama Public" where users may submit supplementary data contained in their projects on PanoramaWeb. The repository provides a permanent location for data to be referenced in publications. Upon submission, a copy of the data contained in the user project is made to Panorama Public. This copy includes user interface elements such as wiki pages, charts and other supplementary figures which were added by the user to their project. Data copied to Panorama Public is read-only, ensuring its availability in the original form accepted for publication. Permissions to the data in Panorama Public are managed as required -- private with access to reviewers while the manuscript is in review and public after the paper has been accepted.

In this tutorial you will you will prepare a folder on PanoramaWeb for submitting to Panorama Public. This will involve uploading documents related to a manuscript and building a custom user interface around the data. Finally, you will go through the steps of submitting the folder to Panorama Public. A large part of this tutorial covers adding custom user interface elements to enhance the presentation and provide context to the supplementary data contained in a folder on PanoramaWeb. If you already have a folder that is ready for publication, you can skip to the section "Submitting to Panorama Public" that covers the steps required for submitting data to Panorama Public.

In this tutorial you will use several features that are part of LabKey Server (https://www.labkey.org), the data management platform behind Panorama, to create a user interface for your supplementary data on PanoramaWeb. Links to detailed documentation provided by labkey.org on individual features are included in the tutorial in yellow boxes like the one below. Please note that these links are not part of the tutorial and are only meant to provide more detailed information on a particular feature in LabKey Server. The link below takes you to the main documentation page on labkey.org.

Getting Started

To start the tutorial, download the following ZIP file:

Extract the files to a folder on your computer, like:
C:\UsersYour_Username\Documents

This will create a new folder:

C:\Users\Your_Username\Documents\SubmitToPanoramaPublic

It will contain all the necessary files for this tutorial.

The data used in this tutorial was published in Abbatiello et al. 2013, where the authors described a system suitability protocol (SSP) that helps to ensure reproducible analyte quantification measurements within a lab or across multiple laboratories with different MS instrument platforms. The SSP was evaluated in 11 laboratories on a total of 15 different instruments, and the data analyzed in Skyline. The resulting Skyline documents were uploaded to PanoramaWeb and made publicly available at:

The data for this tutorial contains Skyline documents from 3 of the participating laboratories, of which one used a ThermoFisher TSQ Vantage instrument and the other two used the SCIEX 4000 QTRAP instrument.

In the following sections you will:

  • Create a folder on PanoramaWeb and upload Skyline documents to the folder.
  • Add wiki pages with text, supplementary figures and tables.
  • Prepare the folder for submission by providing an abstract, organism, instrument information etc.
  • Submit to Panorama Public.

Signing Up for an Account on PanoramaWeb

This tutorial assumes that you will be working in a sub-folder of the "Tutorials" project on PanoramaWeb, the Panorama server hosted by the MacCoss lab at the University of Washington. However, if you already have a project on this server, you are welcome to work in a sub-folder of your project, and skip to the next step.

To request a folder on PanoramaWeb for working through this tutorial, fill out the sign-up form on this page:

Once your request is approved, a folder with full administrative rights will be created for you in the "Tutorials" project on PanoramaWeb. You will also receive a welcoming email with a link to complete your account registration by choosing a password.

Creating a Folder in Panorama

Sign in to PanoramaWeb at https://panoramaweb.org with your username and password. If you are working in the "Tutorials" project follow these steps to navigate to your folder under this project:

  • Click the Projects tab in the upper right corner (shown below) to see a list of all the projects to which you have access on the server.
  • Click the "Tutorials" project.
  • On the project homepage, hover over the project name in the menu bar below the Panorama icon and click on the folder that was created for you. We will use "Your_Username" as the folder name only as an example. Your folder name will be different.

NOTE: Most of the Panorama features that you will explore in the rest of the tutorial require that you have administrative permissions in the folder that you are working in. If you are working in your sub-folder in the "Tutorials" project you are the administrator of the folder. If, however, you are working in another project on PanoramaWeb you must contact your project administrator to ensure that you have administrative permissions.

You will now create a subfolder where you will upload Skyline documents and add other supplementary information for a manuscript. To create a sub-folder for this tutorial, do the following:

  • Click the new folder icon shown in the image below.
  • In the Create Folder form, enter "System Suitability Study" in the folder Name field.
  • Select the Panorama option under Folder Type, as shown below.
  • Click the Next button.
  • On the Users/Permissions page accept the default selection (Inherit From Parent Folder).
  • Click the Next button.
  • On the Configure Panorama Folder page accept the default selection (Experimental data).
  • Click the Finish button.
After successful folder creation, you will be taken to the home page of the "System Suitability Study" folder. You are now ready to upload Skyline documents to this folder.

Uploading Skyline Documents to Panorama

From the tutorial files downloaded earlier, open the "Study9S_Site52_v1.sky" file in Skyline either by double-clicking on the file in Windows Explorer or in Skyline, on the File menu, click Open (Ctrl-O). This file contains measured results for 22 peptides from one of the participating labs in the system suitability study (Abbatiello et al. 2013). To upload this document to the folder you just created on Panorama, follow these steps:

  • Click on the Upload to Panorama button in the Skyline toolbar, shown in the image below. Alternatively, on the File menu, click Upload to Panorama.

If you have not yet set up a Panorama server in Skyline, you will see the following message.

  • Click the Continue button.
Do the following in the Edit Server form:
  • Enter "https://panoramaweb.org" in the URL field.
  • Enter your email address and password on PanoramaWeb.
  • Click the OK button.
Skyline will display a Upload Document form with the folders available to you on PanoramaWeb.

  • In the Panorama Folders field, navigate to and select the "System Suitability Study" folder that you just created on Panorama.
  • Click the OK button.
Wait for the document import to complete. When asked whether you want to view the file in Panorama, click No. Follow the same steps to upload the other two Skyline files in the tutorial data – "Study9S_Site56_v1.sky" and "Study9S_Site65_v1.sky" to your "System Suitability Study" folder on PanoramaWeb.

Once all three documents have been imported into Panorama, go back to the web-browser where the home page of the "System Suitability Study" folder should still be open. Refresh the page (F5 in most browsers) and you will see the three files that you just uploaded in the Targeted MS Runs table.

Customizing Grid Views in Panorama

Click on "Study9S_Site56_v1.sky.zip" in the Targeted MS Runs table to open the details page for the document. The Precursor List table on this page displays a list of precursors in this Skyline document. The Precursor Note/Annotations column in the table, highlighted in the image below, is blank since the researchers did not define any custom precursor annotations in this document.

Do the following to hide this column from the default grid view:

  • Click the (Grid Views) button at the top of the table, just under the Precursor List title.
  • Select Customize Grid from the drop-down menu.

In the customization form that appears, you will see a Selected Fields panel, to the right, that lists the columns that are currently displayed.

  • Scroll down, then hover over Precursor Note/Annotations below Precursor in the Selected Fields panel and click the (remove) icon.
  • Click the Save button.
  • In the Save Custom View form, check Make this grid view available to all users.
This will ensure all users with access to this folder see the same table columns.
  • Click the Save button.

The Precursor Note/Annotations columns should no longer be displayed, as shown below:

Go back to the home page of the "System Suitability Study" folder by clicking on the folder-name link near the top of the page as shown here:

TIP: This folder name link is provided on all pages within the folder except the main home page and provides a quick way to navigate to the home page of that folder.


Click on "Study9S_Site52_v1.sky.zip" in the Targeted MS Runs table. The default view for the Precursor List table for this document should not have the Precursor Note/Annotations column. Custom grid views defined once in a folder apply to all Skyline documents uploaded to the folder. The "default" grid we saved our changes to is shown by default.

Creating Wiki Pages on Panorama

Wiki pages allow you to add content, including file attachments, to your folders on Panorama. You will now create a wiki page to display a supplementary figure (Supplementary Figure 3A) from the original paper along with a figure caption. This figure displays normalized peak areas for the 9 best peptides identified in the study (Abbatiello et al. 2013), across 10 replicates in each site. The original figure has a plot for each of the 15 sites in the study. "SupplFig_3A.png" in the tutorial files has plots for the 3 sites for which Skyline files are included in the tutorial.

Navigate back to the "System Suitability Study" folder home page. To add a wiki page in the folder, we first need to enter "Page Admin Mode" to add a new wiki web part to the folder page.

Do the following:

  • In the header, click the (gear) icon to open the Admin menu. Select Page Admin Mode.
  • From the <Select Web Part> drop-down menu that will appear at the bottom left of the folder home page, scroll down and select Wiki.
  • Click the Add button.

A box titled Wiki will be added under the Targeted MS Runs box that should look like this:

  • Click the Create a new wiki page link to open the wiki editor.
  • Enter "supplementary_figure_3A" in the Name field. The name must be unique in the folder and typically does not contain spaces.
  • Enter "Supplementary Figure 3A" in the Title field. The title is the display title and has no restrictions on uniqueness or spaces for display.
  • In the Body (HTML) field select the Visual tab if it is not already selected.
  • In Notepad or another text editor open the file "SupplFig_3A_caption.txt" contained in the tutorial data you downloaded. Copy and paste the contents of this file into the Body (HTML) field.
  • You can format the text using the options available in the formatting toolbar. - Remove any preformatting by selecting the text and choosing the format "Paragraph".
  • Select the title of the figure caption ("Supplementary Figure 3A") and make it bold by clicking the B button in the toolbar. You can see more formatting options in the toolbar by clicking the Show/hide toolbars button at the left corner of the toolbar.
  • Upload an image file to display on the wiki page:
    • Scroll down, if you need to, to the Files field at the bottom of the wiki editor.
    • Uncheck the Show Attached Files checkbox.
    • Click the Attach a file link and click the Choose File button that appears.
    • Navigate to the folder where you downloaded the tutorial data and select "SupplFig_3A.png".
    • Click on the Open button.
  • Add the image to the wiki page:
    • Place the mouse cursor just before the figure title in the Body(HTML) field.
    • Click the Insert/edit image icon in the toolbar.
    • Enter "SupplFig_3A.png" in the Image URL field of the Insert/edit image dialog.
    • Click Insert in the dialog.
    • Press the "Enter" key on your keyboard once so that the image title is below the image icon in the Body(HTML) field. At this time the actual image will not appear in the editor.
The Body (HTML) field should look like this:

  • Click the Save & Close button at the top left of the wiki editor.
You will be taken back to the "System Suitability Study" folder home page. You should see the wiki page that you just created at the bottom of the page. It should look like this:

A note about "Web Parts" in LabKey Server:

The wiki page that you just created appears on the folder home page in a box with a border and a title that is referred to as a "web part". Web parts are user interface panels that can be added or removed from folder pages by folder administrators when they are in page admin mode. Each web part provides a way for users to view and/or interact with some part of the data contained in the folder. For example, the Wiki web part displays the contents of a specific wiki page. The list of available web parts can be accessed from the two <Select Web Part> menus at the bottom of the folder home page – one on the left side and the other on the right side. The two menus have different sets of available web parts. Web parts selected from the menu on the bottom left of the page are wider and get added to the left side of the page, and those selected from the menu on the bottom right get added to a narrower column on the right side of the page.

The title bar of a web part has controls (available to folder administrators in page admin mode) for moving it up and down the page, relative to other web parts. These controls appear in the right side of the title bar for the wider web parts, shown in the image below.

The term "web part" will be used in the remainder of the tutorial to refer to these user interface elements.

You will now add a table of contents for easy navigation to the wiki pages.

  • Scroll down to the bottom of the page.
  • Choose Wiki Table of Contents from the <Select Web Part> drop-down menu at the bottom right of the page.
  • Click the Add button.
This will add a narrower web part titled Pages to the right side of the folder home page as shown below. Links to all the wiki pages that you add in this folder will appear in this web part.

  • Change the title of the web part by clicking the (triangle) drop-down icon in the title bar and selecting Customize. If you are still in page admin mode, you will see additional options on this menu.
  • Enter "Figures & Tables" as the title (leave the folder path as is) and click the Submit button. The table of contents web part on the home page should now display the updated title. This webpart will allow you to easily navigate to all the wiki pages in this folder as you add additional figures and tables in new wikis.
You will now create another wiki page where you will add a supplementary Excel table containing the retention time drift information. This table has been taken from the original paper and data filtered to the three sites for which Skyline files are included in this tutorial.
  • Add a new wiki page by clicking the drop-down icon in the title bar (which should now read Figures & Tables) of the Wiki Table of Contents web part.
  • Select New from the menu.
Do the following in the wiki editor:
  • Enter "supplementary_table_6" in the Name field.
  • Enter "Supplementary Table 6" in the Title field.
  • In the Body (HTML) field select the Visual tab if it is not already selected.
  • In Notepad or another text editor open the file "SupplTable_6_caption.txt" contained in the tutorial data. Copy and paste the contents of this file in the Body (HTML) field.
  • Remove any preformatting by selecting the text and choosing the format "Paragraph".
  • Format the text using options available in the formatting toolbar. For example, you can make the title ("Supplementary Table 6") bold.
  • In the Files field at the bottom of the wiki editor click the Attach a file link and click the Choose File button.
  • Navigate to the folder where you downloaded the tutorial data and select "SupplTable_6.xlsx".
  • Click the Open button if double clicking does not attach the file and close the popup.
  • Notice that we are leaving the Show Attached Files checkbox checked this time.
  • Click Save & Close at the top of the wiki editor.
The new wiki page should look like this:

Viewers can click the attached file to download it.

Notice that we did not create a new wiki web part for this wiki, so you are viewing the wiki page itself. By default, a search box and a Wiki Table of Contents web part with the title Pages is shown. This web part should display the titles of the two wiki pages you have in the folder. You can click on a title to view either wiki page.

Go back to the home page of the folder by clicking the System Suitability Study link near the top of the page. Notice on the home page that the Figures & Tables is displayed in the table of contents web part here.

Since the wiki pages can now be accessed via the table of contents web part, you can remove the wiki web part that is displaying "Supplementary Figure 3A" from the folder home page.

  • Scroll down, if you need to, so that the title bar of the wiki web part is visible.
  • From the (triangle) menu, select Remove From Page.
    • If you do not see this option, first reenter page admin mode by selecting: Page Admin Mode in the header.
  • Notice that the wiki itself is still available from the table of contents. Removing the web part did not remove the underlying content.

Submitting to Panorama Public

Folders containing supplementary data intended for publication to Panorama Public have to be annotated with a description of the experiment. This includes information such as an abstract, experiment and sample descriptions, organism, MS instruments used etc. To add experiment annotations to the folder, do the following:

  • Go back to the home page of the System Suitability Study folder, if you are not already there.
  • Re-enter > Page Admin Mode if you are not already in this mode.
  • Select Targeted MS Experiment from the <Select Web Part> menu at bottom-left of the page.
  • Click the Add button.

This action will add a web part titled Targeted MS Experiment at the bottom of the page that looks like this:

  • While in page admin mode, you can change the layout of the folder home page to move the Targeted MS Experiment webpart to the top of the page.
    • Move the Targeted MS Experiment web part above the Targeted MS Runs web part by selecting Move Up from the (triangle) menu in the web part title bar.
    • Scroll to the top of the page and remove the Mass Spec Search web part by selecting > Remove From Page in its title bar.
  • Click Exit Admin Mode at the top of the page to hide the page layout editing features.
Next, create the experiment:
  • Click the Create New Experiment link in the Targeted MS Experiment web part.
  • In the Targeted MS Experiment form enter "Multi-lab system suitability study" in the Title field.
  • Start typing "Bos" in the organism field and select "Bos taurus" from the drop-down list.
  • Select "TSQ Vantage" and "4000 QTRAP" in the Instrument field. Start typing the instrument name and select from the drop-down list.
  • In Notepad or another text editor open the file "Abstract.txt" included in the tutorial data. Copy the contents of the file and paste in the Abstract field of the form.
  • In the Keywords field enter "skyline, system-suitability".
  • Enter a Submitter Affiliation.
  • Click the Submit button at the bottom of the form.

You will be taken to the experiment details page. All the Skyline documents you upload to this folder will get added to the experiment and will appear in the Targeted MS Runs table. In this tutorial you have uploaded all the Skyline files to a single folder. If, however, your data is organized in subfolders, you will see a panel titled Subfolders. You can click the Include Subfolders button in this panel to include data from subfolders in your experiment prior to submitting to Panorama Public. You can find more details on this documentation page. Navigate back to the folder home page by clicking the System Suitability Study link near the top of the page.

To submit to Panorama Public, click the red Submit button in the Targeted MS Experiment web part.

Panorama Public is a member repository of the ProteomeXchange consortium. Data submitted to Panorama Public that fulfills ProteomeXchange submission requirements will be assigned a ProteomeXchange Id and announced on ProteomeCentral. For more details refer to this documentation page: Data Validation for ProteomeXchange
Click the Validate Data for ProteomeXchange button on the next page. The data validation process will check for:
  • All the raw files imported into the Skyline documents being submitted have been uploaded. This is the minimum requirement for getting a ProteomeXchange Id.
  • All the modifications used in the Skyline documents have a Unimod Id.
  • The source files (spectrum files + search results files) used to build any spectral libraries used with the Skyline documents are uploaded.

This will start a data validation process in the background. This page will refresh automatically with the validation progress.

Validation results will be displayed when the validation job is complete. Since the raw files used with the Skyline documents have not been uploaded, the validation status displayed should be - "Data is not valid for a ProteomeXchange submission".

Learn more about data validation for ProteomeXchange here: Data Validation for ProteomeXchange

Expand the nodes next to the Skyline document names in the "Skyline Document Sample Files" grid to view the names of the missing raw data files. Click the Upload Files button.

On the "Upload Missing Sample Files" page drag and drop the raw files from the "Raw Files" subfolder of the tutorial data. You can select multiple files and drop them into the files browser. After the files are uploaded click the Rerun Validation button.

When the validation job is complete the status displayed should be - "Incomplete data and / or metadata". The "Skyline Document Sample Files" grid should show a "Complete" status for all the Skyline documents. This means that the data can be assigned a ProteomeXchange Id, but there is some more information required for a "complete" ProteomeXchange submission. In the "Modifications" grid there is no Unimod Id for "Carboxymethylcysteine". Click the "Find Match" link in the "Unimod Match" column.

On the "Unimod Match Options" page click the Unimod Match button to find a Unimod Id for Carboxymethylcysteine.

The match found for Carboxymethylcysteine should be "Carboxymethyl, Unimod:6". Click the Save Match button.

After saving the Unimod match, the status on the validation results page should be "Complete". Click the Continue Submission button.

You will be presented with a form that looks similar to the image below:

In the Submission Request to Panorama Public form do the following:

  • If you were working in a folder with real data for a manuscript, you would select "Panorama Public" from the drop-down list next to the Submit To option (it is the default, shown above). For this tutorial, select "Panorama Public Tutorial".
  • Enter "publication _tutorial_<your_ folder_name>" in the Access Link field. Replace <your_ folder_name> with the name of your folder in the "Tutorials" project. For example, if you folder name is "Your_Username" enter "publication_tutorial_Your_Username" in the textbox. The URL displayed below the textbox will be updated as you type in the textbox. Once you have finished typing the URL should read (for folder "Your_Username")
    https://panoramaweb.org/publication_tutorial_Your_Username.url
  • Uncheck the Keep Private checkbox. If you were submitting data for a manuscript undergoing peer review you could keep the Keep Private box checked. This will ensure that when the data is copied to Panorama Public, it will be kept private with read-only access to the submitter. Another read-only reviewer account will be created for the data, and account details provided to the submitter. These account details can be conveyed to the journal where the manuscript is submitted.
  • Click the Submit button.
The Access Link provided in the UI in bold is the link that you will include in your manuscript to link to supplementary data on Panorama Public that can be viewed in a web browser. Initially, this link points to your folder on PanoramaWeb. But once a copy of your data has been made to Panorama Public, it will link to the location of the copied data on Panorama Public. This will be the permanent location of your supplementary data on Panorama Public.

The Submission Request to Panorama Public form allows you to "build" this access link. The initial part of the link remains constant: https://panoramaweb.org/. You can choose a string to complete the link (highlighted in yellow below).

https://panoramaweb.org/choose_a_string.url

The initial value entered in the Access Link field is a randomly generated alphanumeric string. You can replace it with a convenient, easy to remember string. This string has to be unique across all the experiments submitted to Panorama Public. You may get an error if the link you entered is already in use for another experiment on Panorama Public. If this happens change the text and try again.

When the form is submitted successfully you will be taken to the experiment details page.

In the Experiment Details box, you will see a red "Copy Pending!" message, circled below. This message will disappear once your data has been copied to Panorama Public. Any changes that you make in the folder, such as adding/removing Skyline documents or wiki pages, or changing the layout of the page will also get copied when a copy is made to Panorama Public. At the bottom of the page, in the Submission table, you will see the Access Link that you created for this experiment. The Copied column, circled below will be blank until a copy has been made successfully.

Once the data has been copied this column will display the date when the data was copied. You will also receive an email informing you that the data was successfully copied to Panorama Public. At that point if you click on the value in the Access Link column you will be taken to the folder where your data was copied on Panorama Public and you can verify that the data, folder layout, and views were copied accurately.

Requests to copy data are handled by Panorama Public administrators within a week of submission. Once your data has been successfully copied to Panorama Public you will receive a confirmation email. If you requested that your data on Panorama Public be kept private (e.g. for a manuscript under peer review), the confirmation email will also include reviewer account details. You can pass on the account details to the journal where you are submitting your manuscript.

Reference List

1. Abbatiello, S. E., Mani, D. R., Schilling, B., MacLean, B., Zimmerman, L. J., Feng, X., … Carr, S. A. (2013). Design, Implementation and Multisite Evaluation of a System Suitability Protocol for the Quantitative Assessment of Instrument Performance in Liquid Chromatography-Multiple Reaction Monitoring-MS (LC-MRM-MS). Molecular & Cellular Proteomics : MCP, 12(9), 2623–2639. doi:10.1074/mcp.M112.027078

On Oct 20, 2015, the Skyline and Panorama Teams produced Webinar #11: Panorama Public and Panorama AutoQC, another great resource to learn more about some of the new aspects of Panorama.



Webinars


Panorama Webinar hosted by LabKey (June 29, 2021) System Suitability Best Practices with Skyline and Panorama webinar -

Panorama Webinar hosted by LabKey (September 21, 2017) Introduction to Panorama

Skyline Tutorial Webinar #11 (October 20, 2015) Panorama Public and Panorama AutoQC

Webinar August 19, 2014Panorama: Managing and Analyzing Large Datasets

Webinar August 8, 2013: Panorama targeted proteomics knowledge base




System Suitability Best Practices With Skyline & Panorama


Panorama Webinar hosted by LabKey (June 29, 2021)
System Suitability Best Practices with Skyline and Panorama webinar




Introduction to Panorama 17.2



Panorama Webinar hosted by LabKey (September 21, 2017) Introduction to Panorama 17.2




Panorama Public and Panorama AutoQC


Skyline Webinar #11 (October 20, 2015)
Panorama Public and Panorama AutoQC




Panorama: An Introduction


Webinar: Introduction to Panorama for Targeted Proteomics Research
  • Panorama: An Introduction



  • Panorama: Managing and Analyzing Large Datasets





    Panorama Targeted Proteomics Knowledge Base





    Publications


    Peer reviewed manuscripts

    • Panorama: A Targeted Proteomics Knowledge Base. Sharma V, Eckels J, Taylor GK, Shulman NJ, Stergachis AB, Joyner SA, Yan P, Whiteaker JR, Halusa GN, Schilling B, Gibson BW, Colangelo CM, Paulovich AG, Carr SA, Jaffe JD, MacCoss MJ, MacLean B. Journal of Proteome Research. 2014 [abstract] [pdf]
    • Panorama Public: A public repository for quantitative data sets processed in Skyline. Vagisha Sharma, Josh Eckels, Birgit Schilling, Christina Ludwig, Jacob D. Jaffe, Michael J. MacCoss and Brendan MacLean. Molecular and Cellular Proteomics. 2018 [abstract] [pdf]
    • An Automated Pipeline to Monitor System Performance in Liquid Chromatography Tandem Mass Spectrometry Proteomic Experiments. Michael S. Bereman, Joshua Beri, Vagisha Sharma, Cory Nathe, Josh Eckels, Brendan MacLean, Michael J. MacCoss. Journal of Proteome Research. 2016 [abstract] [pdf]

    Posters

    • Panorama Public: ProteomeXchange and Cloud Storage Integration. Sharma V, Connolly B, Eckels J, Bradlee D, Omaiye A, MacCoss MJ, MacLean B. ASMS Poster. 2019 [pdf]
    • Customizable quality control metrics and notifications with Panorama, AutoQC, and Skyline. Eckels J, Sharma V, Pradere M, Juneja A, Omaiye A, Nathe C, Jewargikar S, MacCoss MJ, MacLean B. ASMS Poster. 2019 [pdf]
    • Audit Logs to enforce document integrity in Skyline and Panorama . Rhode T, Chupalov R, Shulman N, Sharma V, Eckels J, Pratt BS, MacCoss MJ, MacLean B. ASMS Poster. 2019 [pdf]
    • Managing Small Molecule Targeted Mass Spec Assays using Skyline and Panorama. Eckels J, Sharma V, Pratt B, Dunkley T, Wildsmith K, Anania V, Li Q, Nathe C, Patel B, MacCoss MJ, MacLean B. ASMS Poster. 2016 [pdf]
    • Performing quality control on targeted proteomics assays using Skyline and Panorama. Eckels J, Sharma V, Boss Y, Shi H, Dunkley T, Wildsmith K, Nathe C, Robinson A, Johnson R, Jaffe JD, MacCoss MJ, MacLean B. ASMS Poster. 2015 [pdf]
    • Panorama Public: A public repository for Skyline documents. Sharma V, Eckels J, Schilling B, Jaffe JD, MacCoss MJ, Brendan MacLean. ASMS Poster. 2015 [pdf]
    • Sharing targeted proteomics assays using Skyline and Panorama. Eckels J, Sharma V, MacLean B, Taylor GK, Shulman NJ, Stergachis AB, Joyner SA, Jaffe JD, MacCoss MJ. ASMS Poster. 2013 [pdf]
    • Panorama: A Private Repository of Targeted Proteomics Assays for Skyline. Sharma V, MacLean B, Eckels J, Stergachis AB, Jaffe JD, MacCoss MJ. ASMS Poster. 2012 [pdf]



    Dashboard


    Projects on PanoramaWeb
    PanoramaWeb currently hosts projects for labs.
    Skyline Documents on PanoramaWeb
    Skyline documents have been uploaded to PanoramaWeb.



    Example Data


    System suitability
    Chromatogram library
    Multi Attribute Method (MAM)
    Small molecule
    Experimental data
     

    Developers with experience creating SQL queries, R, Perl, Python or other scripts may be interested in exploring the Query Schema Browser to see the underlying data structures exposed for SQL queries, especially the queries in the targetedms schema, or LabKey Server client API requests.




    Related


    Skyline
    Learn more about Skyline software for large-scale proteomics studies.

    LabKey Server
    Learn more about LabKey Server: Data management software built with scientists, for scientists.




    University of Washington





    Archived


    The documentation under this node are for an older version for Panorama Public



    Tutorial: Submitting Supplementary Data to Panorama Public


    This tutorial is outdated. View the current tutorial at Submitting Supplementary Data to Panorama Public.

    Overview

    PanoramaWeb (https://panoramaweb.org), the public Panorama server hosted at the University of Washington is being increasingly used by researchers to host data processed in Skyline for sharing with collaborators and for referencing in published papers. Users on PanoramaWeb are given their own projects over which they have full administrative control. The ease of uploading Skyline documents to Panorama combined with the ability to configure permissions and folder structure makes PanoramaWeb an attractive choice for hosting and sharing data from Skyline centric workflows. It also makes it possible for users to provide public access to data for fulfilling journal submission requirements. Several papers have already been published that reference supplementary Skyline documents hosted on PanoramaWeb. However, data in user projects remains under the control of the user, and may be edited or deleted post publication.

    To address this concern, PanoramaWeb now hosts a public repository called "Panorama Public" where users may submit supplementary data contained in their projects on PanoramaWeb. The repository provides a permanent location for data to be referenced in publications. Upon submission, a copy of the data contained in the user project is made to Panorama Public. This copy includes user interface elements such as wiki pages, charts and other supplementary figures which were added by the user to their project. Data copied to Panorama Public is read-only, ensuring its availability in the original form accepted for publication. Permissions to the data in Panorama Public are managed as required -- private with access to reviewers while the manuscript is in review and public after the paper has been accepted.

    In this tutorial you will you will prepare a folder on PanoramaWeb for submitting to Panorama Public. This will involve uploading documents related to a manuscript and building a custom user interface around the data. Finally, you will go through the steps of submitting the folder to Panorama Public. A large part of this tutorial covers adding custom user interface elements to enhance the presentation and provide context to the supplementary data contained in a folder on PanoramaWeb. If you already have a folder that is ready for publication, you can skip to the section "Submitting to Panorama Public" that covers the steps required for submitting data to Panorama Public.

    In this tutorial you will use several features that are part of LabKey Server (https://www.labkey.org), the data management platform behind Panorama, to create a user interface for your supplementary data on PanoramaWeb. Links to detailed documentation provided by labkey.org on individual features are included in the tutorial in yellow boxes like the one below. Please note that these links are not part of the tutorial and are only meant to provide more detailed information on a particular feature in LabKey Server. The link below takes you to the main documentation page on labkey.org.

    Getting Started

    To start the tutorial, download the following ZIP file:

    Extract the files to a folder on your computer, like:
    C:\UsersYour_Username\Documents

    This will create a new folder:

    C:\Users\Your_Username\Documents\SubmitToPanoramaPublic

    It will contain all the necessary files for this tutorial.

    The data used in this tutorial was published in Abbatiello et al. 2013, where the authors described a system suitability protocol (SSP) that helps to ensure reproducible analyte quantification measurements within a lab or across multiple laboratories with different MS instrument platforms. The SSP was evaluated in 11 laboratories on a total of 15 different instruments, and the data analyzed in Skyline. The resulting Skyline documents were uploaded to PanoramaWeb and made publicly available at:

    The data for this tutorial contains Skyline documents from 3 of the participating laboratories, of which one used a ThermoFisher TSQ Vantage instrument and the other two used the SCIEX 4000 QTRAP instrument.

    In the following sections you will:

    • Create a folder on PanoramaWeb and upload Skyline documents to the folder.
    • Add wiki pages with text, supplementary figures and tables.
    • Prepare the folder for submission by providing an abstract, organism, instrument information etc.
    • Submit to Panorama Public.

    Signing Up for an Account on PanoramaWeb

    This tutorial assumes that you will be working in a sub-folder of the "Tutorials" project on PanoramaWeb, the Panorama server hosted by the MacCoss lab at the University of Washington. However, if you already have a project on this server, you are welcome to work in a sub-folder of your project, and skip to the next step.

    To request a folder on PanoramaWeb for working through this tutorial, fill out the sign-up form on this page:

    Once your request is approved, a folder with full administrative rights will be created for you in the "Tutorials" project on PanoramaWeb. You will also receive a welcoming email with a link to complete your account registration by choosing a password.

    Creating a Folder in Panorama

    Sign in to PanoramaWeb at https://panoramaweb.org with your username and password. If you are working in the "Tutorials" project follow these steps to navigate to your folder under this project:

    • Click the Projects tab in the upper right corner (shown below) to see a list of all the projects to which you have access on the server.
    • Click the "Tutorials" project.
    • On the project homepage, hover over the project name in the menu bar below the Panorama icon and click on the folder that was created for you. We will use "Your_Username" as the folder name only as an example. Your folder name will be different.

    NOTE: Most of the Panorama features that you will explore in the rest of the tutorial require that you have administrative permissions in the folder that you are working in. If you are working in your sub-folder in the "Tutorials" project you are the administrator of the folder. If, however, you are working in another project on PanoramaWeb you must contact your project administrator to ensure that you have administrative permissions.

    You will now create a subfolder where you will upload Skyline documents and add other supplementary information for a manuscript. To create a sub-folder for this tutorial, do the following:

    • Click the new folder icon shown in the image below.
    • In the Create Folder form, enter "System Suitability Study" in the folder Name field.
    • Select the Panorama option under Folder Type, as shown below.
    • Click the Next button.
    • On the Users/Permissions page accept the default selection (Inherit From Parent Folder).
    • Click the Next button.
    • On the Configure Panorama Folder page accept the default selection (Experimental data).
    • Click the Finish button.
    After successful folder creation, you will be taken to the home page of the "System Suitability Study" folder. You are now ready to upload Skyline documents to this folder.

    Uploading Skyline Documents to Panorama

    From the tutorial files downloaded earlier, open the "Study9S_Site52_v1.sky" file in Skyline either by double-clicking on the file in Windows Explorer or in Skyline, on the File menu, click Open (Ctrl-O). This file contains measured results for 22 peptides from one of the participating labs in the system suitability study (Abbatiello et al. 2013). To upload this document to the folder you just created on Panorama, follow these steps:

    • Click on the Upload to Panorama button in the Skyline toolbar, shown in the image below. Alternatively, on the File menu, click Upload to Panorama.

    If you have not yet set up a Panorama server in Skyline, you will see the following message.

    • Click the Continue button.
    Do the following in the Edit Server form:
    • Enter "https://panoramaweb.org" in the URL field.
    • Enter your email address and password on PanoramaWeb.
    • Click the OK button.
    Skyline will display a Upload Document form with the folders available to you on PanoramaWeb.

    • In the Panorama Folders field, navigate to and select the "System Suitability Study" folder that you just created on Panorama.
    • Click the OK button.
    Wait for the document import to complete. When asked whether you want to view the file in Panorama, click No. Follow the same steps to upload the other two Skyline files in the tutorial data – "Study9S_Site56_v1.sky" and "Study9S_Site65_v1.sky" to your "System Suitability Study" folder on PanoramaWeb.

    Once all three documents have been imported into Panorama, go back to the web-browser where the home page of the "System Suitability Study" folder should still be open. Refresh the page (F5 in most browsers) and you will see the three files that you just uploaded in the Targeted MS Runs table.

    Customizing Grid Views in Panorama

    Click on "Study9S_Site56_v1.sky.zip" in the Targeted MS Runs table to open the details page for the document. The Precursor List table on this page displays a list of precursors in this Skyline document. The Precursor Note/Annotations column in the table, highlighted in the image below, is blank since the researchers did not define any custom precursor annotations in this document.

    Do the following to hide this column from the default grid view:

    • Click the (Grid Views) button at the top of the table, just under the Precursor List title.
    • Select Customize Grid from the drop-down menu.

    In the customization form that appears, you will see a Selected Fields panel, to the right, that lists the columns that are currently displayed.

    • Scroll down, then hover over Precursor Note/Annotations below Precursor in the Selected Fields panel and click the (remove) icon.
    • Click the Save button.
    • In the Save Custom View form, check Make this grid view available to all users.
    This will ensure all users with access to this folder see the same table columns.
    • Click the Save button.

    The Precursor Note/Annotations columns should no longer be displayed, as shown below:

    Go back to the home page of the "System Suitability Study" folder by clicking on the folder-name link near the top of the page as shown here:

    TIP: This folder name link is provided on all pages within the folder except the main home page and provides a quick way to navigate to the home page of that folder.


    Click on "Study9S_Site52_v1.sky.zip" in the Targeted MS Runs table. The default view for the Precursor List table for this document should not have the Precursor Note/Annotations column. Custom grid views defined once in a folder apply to all Skyline documents uploaded to the folder. The "default" grid we saved our changes to is shown by default.

    Creating Wiki Pages on Panorama

    Wiki pages allow you to add content, including file attachments, to your folders on Panorama. You will now create a wiki page to display a supplementary figure (Supplementary Figure 3A) from the original paper along with a figure caption. This figure displays normalized peak areas for the 9 best peptides identified in the study (Abbatiello et al. 2013), across 10 replicates in each site. The original figure has a plot for each of the 15 sites in the study. "SupplFig_3A.png" in the tutorial files has plots for the 3 sites for which Skyline files are included in the tutorial.

    Navigate back to the "System Suitability Study" folder home page. To add a wiki page in the folder, we first need to enter "Page Admin Mode" to add a new wiki web part to the folder page.

    Do the following:

    • In the header, click the (gear) icon to open the Admin menu. Select Page Admin Mode.
    • From the <Select Web Part> drop-down menu that will appear at the bottom left of the folder home page, scroll down and select Wiki.
    • Click the Add button.

    A box titled Wiki will be added under the Targeted MS Runs box that should look like this:

    • Click the Create a new wiki page link to open the wiki editor.
    • Enter "supplementary_figure_3A" in the Name field. The name must be unique in the folder and typically does not contain spaces.
    • Enter "Supplementary Figure 3A" in the Title field. The title is the display title and has no restrictions on uniqueness or spaces for display.
    • In the Body (HTML) field select the Visual tab if it is not already selected.
    • In Notepad or another text editor open the file "SupplFig_3A_caption.txt" contained in the tutorial data you downloaded. Copy and paste the contents of this file into the Body (HTML) field.
    • You can format the text using the options available in the formatting toolbar. - Remove any preformatting by selecting the text and choosing the format "Paragraph".
    • Select the title of the figure caption ("Supplementary Figure 3A") and make it bold by clicking the B button in the toolbar. You can see more formatting options in the toolbar by clicking the Show/hide toolbars button at the left corner of the toolbar.
    • Upload an image file to display on the wiki page:
      • Scroll down, if you need to, to the Files field at the bottom of the wiki editor.
      • Uncheck the Show Attached Files checkbox.
      • Click the Attach a file link and click the Choose File button that appears.
      • Navigate to the folder where you downloaded the tutorial data and select "SupplFig_3A.png".
      • Click on the Open button.
    • Add the image to the wiki page:
      • Place the mouse cursor just before the figure title in the Body(HTML) field.
      • Click the Insert/edit image icon in the toolbar.
      • Enter "SupplFig_3A.png" in the Image URL field of the Insert/edit image dialog.
      • Click Insert in the dialog.
      • Press the "Enter" key on your keyboard once so that the image title is below the image icon in the Body(HTML) field. At this time the actual image will not appear in the editor.
    The Body (HTML) field should look like this:

    • Click the Save & Close button at the top left of the wiki editor.
    You will be taken back to the "System Suitability Study" folder home page. You should see the wiki page that you just created at the bottom of the page. It should look like this:

    A note about "Web Parts" in LabKey Server:

    The wiki page that you just created appears on the folder home page in a box with a border and a title that is referred to as a "web part". Web parts are user interface panels that can be added or removed from folder pages by folder administrators when they are in page admin mode. Each web part provides a way for users to view and/or interact with some part of the data contained in the folder. For example, the Wiki web part displays the contents of a specific wiki page. The list of available web parts can be accessed from the two <Select Web Part> menus at the bottom of the folder home page – one on the left side and the other on the right side. The two menus have different sets of available web parts. Web parts selected from the menu on the bottom left of the page are wider and get added to the left side of the page, and those selected from the menu on the bottom right get added to a narrower column on the right side of the page.

    The title bar of a web part has controls (available to folder administrators in page admin mode) for moving it up and down the page, relative to other web parts. These controls appear in the right side of the title bar for the wider web parts, shown in the image below.

    The term "web part" will be used in the remainder of the tutorial to refer to these user interface elements.

    You will now add a table of contents for easy navigation to the wiki pages.

    • Scroll down to the bottom of the page.
    • Choose Wiki Table of Contents from the <Select Web Part> drop-down menu at the bottom right of the page.
    • Click the Add button.
    This will add a narrower web part titled Pages to the right side of the folder home page as shown below. Links to all the wiki pages that you add in this folder will appear in this web part.

    • Change the title of the web part by clicking the (triangle) drop-down icon in the title bar and selecting Customize. If you are still in page admin mode, you will see additional options on this menu.
    • Enter "Figures & Tables" as the title (leave the folder path as is) and click the Submit button. The table of contents web part on the home page should now display the updated title. This webpart will allow you to easily navigate to all the wiki pages in this folder as you add additional figures and tables in new wikis.
    You will now create another wiki page where you will add a supplementary Excel table containing the retention time drift information. This table has been taken from the original paper and data filtered to the three sites for which Skyline files are included in this tutorial.
    • Add a new wiki page by clicking the drop-down icon in the title bar (which should now read Figures & Tables) of the Wiki Table of Contents web part.
    • Select New from the menu.
    Do the following in the wiki editor:
    • Enter "supplementary_table_6" in the Name field.
    • Enter "Supplementary Table 6" in the Title field.
    • In the Body (HTML) field select the Visual tab if it is not already selected.
    • In Notepad or another text editor open the file "SupplTable_6_caption.txt" contained in the tutorial data. Copy and paste the contents of this file in the Body (HTML) field.
    • Remove any preformatting by selecting the text and choosing the format "Paragraph".
    • Format the text using options available in the formatting toolbar. For example, you can make the title ("Supplementary Table 6") bold.
    • In the Files field at the bottom of the wiki editor click the Attach a file link and click the Choose File button.
    • Navigate to the folder where you downloaded the tutorial data and select "SupplTable_6.xlsx".
    • Click the Open button if double clicking does not attach the file and close the popup.
    • Notice that we are leaving the Show Attached Files checkbox checked this time.
    • Click Save & Close at the top of the wiki editor.
    The new wiki page should look like this:

    Viewers can click on the attached file to download it.

    Notice that we did not create a new wiki web part for this wiki, so you are viewing the wiki page itself. By default, a search box and a Wiki Table of Contents web part with the title Pages is shown. This web part should display the titles of the two wiki pages you have in the folder. You can click on a title to view either wiki page.

    Go back to the home page of the folder by clicking the System Suitability Study link near the top of the page. Notice on the home page that the Figures & Tables is displayed in the table of contents web part here.

    Since the wiki pages can now be accessed via the table of contents web part, you can remove the wiki web part that is displaying "Supplementary Figure 3A" from the folder home page.

    • Scroll down, if you need to, so that the title bar of the wiki web part is visible.
    • From the (triangle) menu, select Remove From Page.
      • If you do not see this option, first reenter page admin mode by selecting: Page Admin Mode in the header.
    • Notice that the wiki itself is still available from the table of contents. Removing the web part did not remove the underlying content.

    Submitting to Panorama Public

    Folders containing supplementary data intended for publication to Panorama Public have to be annotated with a description of the experiment. This includes information such as an abstract, experiment and sample descriptions, organism, MS instruments used etc. To add experiment annotations to the folder, do the following:

    • Go back to the home page of the System Suitability Study folder, if you are not already there.
    • Re-enter > Page Admin Mode if you are not already in this mode.
    • Select Targeted MS Experiment from the <Select Web Part> menu at bottom-left of the page.
    • Click the Add button.

    This action will add a web part titled Targeted MS Experiment at the bottom of the page that looks like this:

    • While in page admin mode, you can change the layout of the folder home page to move the Targeted MS Experiment webpart to the top of the page.
      • Move the Targeted MS Experiment web part above the Targeted MS Runs web part by selecting Move Up from the (triangle) menu in the web part title bar.
      • Scroll to the top of the page and remove the Mass Spec Search web part by selecting > Remove From Page in its title bar.
    • Click Exit Admin Mode at the top of the page to hide the page layout editing features.
    Next, create the experiment:
    • Click the Create New Experiment link in the Targeted MS Experiment web part.
    • In the Targeted MS Experiment form enter "System Suitability Study" in the Title field.
    • Enter "TSQ Vantage, 4000 QTRAP" in the Instrument field
    • In Notepad or another text editor open the file "Abstract.txt" included in the tutorial data. Copy the contents of the file and paste in the Abstract field of the form.
    • Click the Submit button at the bottom of the form.

    You will be taken to the experiment details page. All the Skyline documents you upload to this folder will get added to the experiment and will appear in the Targeted MS Runs table. In this tutorial you have uploaded all the Skyline files to a single folder. If, however, your data is organized in subfolders, you will see a panel titled Subfolders. You can click the Include Subfolders button in this panel to include data from subfolders in your experiment prior to submitting to Panorama Public. You can find more details on this documentation page.

    Navigate back to the folder home page by clicking the System Suitability Study link near the top of the page.

    To submit to Panorama Public, click the red Submit button in the Targeted MS Experiment web part.

    You will be presented with a form that looks similar to the image below:

    In the Submission Request to Panorama Public form do the following:

    • If you were working in a folder with real data for a manuscript, you would select "Panorama Public" from the drop-down list next to the Submit To option (it is the default, shown above). For this tutorial, select "Panorama Public Tutorial".
    • Enter "publication _tutorial_<your_ folder_name>" in the Access Link field. Replace <your_ folder_name> with the name of your folder in the "Tutorials" project. For example, if you folder name is "Your_Username" enter "publication_tutorial_Your_Username" in the textbox. The URL displayed below the textbox will be updated as you type in the textbox. Once you have finished typing the URL should read (for folder "Your_Username")
      https://panoramaweb.org/publication_tutorial_Your_Username.url
    • Uncheck the Keep Private checkbox. If you were submitting data for a manuscript undergoing peer review you could keep the Keep Private box checked. This will ensure that when the data is copied to Panorama Public, it will be kept private with read-only access to the submitter. Another read-only reviewer account will be created for the data, and account details provided to the submitter. These account details can be conveyed to the journal where the manuscript is submitted.
    • Click the Submit button.
    The Access Link provided in the UI in bold is the link that you will include in your manuscript to link to supplementary data on Panorama Public that can be viewed in a web browser. Initially, this link points to your folder on PanoramaWeb. But once a copy of your data has been made to Panorama Public, it will link to the location of the copied data on Panorama Public. This will be the permanent location of your supplementary data on Panorama Public.

    The Submission Request to Panorama Public form allows you to "build" this access link. The initial part of the link remains constant: https://panoramaweb.org/. You can choose a string to complete the link (highlighted in yellow below).

    https://panoramaweb.org/choose_a_string.url

    The initial value entered in the Access Link field is a randomly generated alphanumeric string. You can replace it with a convenient, easy to remember string. This string has to be unique across all the experiments submitted to Panorama Public. You may get an error if the link you entered is already in use for another experiment on Panorama Public. If this happens change the text and try again.

    NOTE: Panorama Public is a now a member repository of the ProteomeXchange consortium. Data submitted to Panorama Public that fulfills ProteomeXchange submission requirements will be assigned a ProteomeXchange ID and announced on ProteomeCentral. When you click the Submit button in the form your data will be checked for completeness for a ProteomeXchange submission. If there is missing information, such as missing raw data or missing metadata, it will be listed on a page after you click the Submit button. You can click the submit button again after you have provided all the missing information. Alternatively, if you do not want a ProteomeXchange ID for your submission you can proceed to the submission form by clicking the Continue without ProteomeXchange ID link. For more details refer to this documentation page: Submit Data to Panorama Public

    When the form is submitted successfully you will be taken to the experiment details page.

    In the Experiment Details box, you will see a red "Copy Pending!" message, circled below. This message will disappear once your data has been copied to Panorama Public. Any changes that you make in the folder, such as adding/removing Skyline documents or wiki pages, or changing the layout of the page will also get copied when a copy is made to Panorama Public. At the bottom of the page, in the Submission table, you will see the Access Link that you created for this experiment. The Copied column, circled below will be blank until a copy has been made successfully.

    Once the data has been copied this column will display the date when the data was copied. You will also receive an email informing you that the data was successfully copied to Panorama Public. At that point if you click on the value in the Access Link column you will be taken to the folder where your data was copied on Panorama Public and you can verify that the data, folder layout, and views were copied accurately.

    Requests to copy data are handled by Panorama Public administrators within a week of submission. Once your data has been successfully copied to Panorama Public you will receive a confirmation email. If you requested that your data on Panorama Public be kept private (e.g. for a manuscript under peer review), the confirmation email will also include reviewer account details. You can pass on the account details to the journal where you are submitting your manuscript.

    Reference List

    1. Abbatiello, S. E., Mani, D. R., Schilling, B., MacLean, B., Zimmerman, L. J., Feng, X., … Carr, S. A. (2013). Design, Implementation and Multisite Evaluation of a System Suitability Protocol for the Quantitative Assessment of Instrument Performance in Liquid Chromatography-Multiple Reaction Monitoring-MS (LC-MRM-MS). Molecular & Cellular Proteomics : MCP, 12(9), 2623–2639. doi:10.1074/mcp.M112.027078

    On Oct 20, 2015, the Skyline and Panorama Teams produced Webinar #11: Panorama Public and Panorama AutoQC, another great resource to learn more about some of the new aspects of Panorama.



    Submit Data to Panorama Public


    This documentation is outdated. View the current document at Submit Data to Panorama Public.
    PanoramaWeb hosts a public repository called Panorama Public where users may submit supplementary data associated with manuscripts that have been published or are under review. The repository provides a permanent location for data that can be referenced in publications. Users with data in their own projects on PanoramaWeb can follow the instructions below to submit the data to Panorama Public. The PanoramaWeb site administrators will review the submission request and make a copy of the data to Panorama Public. Reviewer account details will be provided to the submitter if the data is for a manuscript undergoing peer review, and the copy on Panorama Public will be kept private until the manuscript is accepted for publication. Data copied to Panorama Public is read-only, ensuring its availability in the original form accepted for publication.

    Panorama Public is a member repository of the ProteomeXchange consortium. Data submitted to Panorama Public that fulfills ProteomeXchange submission requirements will be assigned a ProteomeXchange identifier and announced on ProteomeCentral.

    Submitting Data to Panorama Public

    STEP 1: Upload Skyline documents and other files to a folder on PanoramaWeb

    Refer to the following wiki pages to create a folder in your project on PanoramaWeb and upload Skyline documents and associated data.


    STEP 2: Prepare the folder for submission to Panorama Public

    Folders containing supplementary data intended for submission to Panorama Public have to be annotated with a description of the experiment. This includes information such as an abstract, experiment and sample descriptions, organism, MS instruments used etc. To add experiment annotations to a folder, do the following:

    • Go to the home page of the folder by navigating the folder menu under the Panorama logo (Folder Navigation).
    • Click the gear icon in the top right corner of the page, then select Page Admin Mode from the drop-down menu.
    • Scroll to the bottom of the page and select Targeted MS Experiment from the <Select Web Part> menu at the bottom-left of the page.
    • Click the Add button. This action will add a web part titled Targeted MS Experiment at the bottom of the page that looks like this:
    • Click the Create New Experiment link in the Targeted MS Experiment web part.
    • Fill out the Targeted MS Experiment form.

    The Instrument and Organism fields are auto-complete fields. Type 3 or more letters to see a drop-down list of matching options. Continue typing to refine the list and select from one of the available options. Contact the Panorama team if you do not see your instrument or organism in the list. At least one organism and one instrument is required for a ProteomeXchange submission.

    In addition to an organism and an instrument, Keywords describing the data also need to be filled in for a ProteomeXchange submission. Contact details of the data submitter and a lab head are also required. In the Targeted MS Experiment form, the currently logged in user is auto-selected as the submitter. Please fill in the Submitter Affiliation for the submitting user. You can select a lab head from the drop-down menu in the Lab Head field which lists all users that have administrative privileges in the folder. If your lab head does not have an account on the server, you may create one by referring to Adding Users to a Project. If you do not wish to create an account for the lab head you can leave the Lab Head and Lab Head Affiliation fields blank. You will have the option of entering a lab head name and affiliation when you submit the data to Panorama Public.

    • Click the Submit button at the bottom of the form.
    You will be taken to the experiment details page. All the Skyline documents that were uploaded to the folder where you added the Targeted MS Experiment webpart will get added to the experiment and will appear in the Targeted MS Runs table. If your data is organized in subfolders under the main folder, you should click the Include Subfolders button shown in the image below.


    STEP 3: Submit the annotated folder to Panorama Public
    • Navigate back to the folder home page by clicking on the link with the icon and folder name near the top of the page.
    • Scroll down, if you need to, so that you can see the Targeted MS Experiment web part.
    • Click the red Submit button in the Targeted MS Experiment web part.


    Your data will be checked for completeness for a ProteomeXchange submission. If there is missing information, such as missing raw data or missing metadata, it will be listed on a page after you click the Submit button. You can click the submit button again after you have provided all the missing information. Alternatively, if you do not want a ProteomeXchange ID for your submission you can proceed to the submission form by clicking the Continue without ProteomeXchange ID link shown below.


    After you have provided all the missing information or clicked on the link to continue without a ProteomeXchange ID you will be presented with a form that looks similar to the one in the image below:


    If you did not enter a lab head in the Targeted MS Experiment form, and a ProteomeXchange ID will be requested for your data, you will see additional fields in the form:

    If you do not fill in the lab head details in this form, the submitting user's information will be used in the lab head field when announcing the data to ProteomeXchange.

    In the Submission Request to Panorama Public form do the following:
    • Select “Panorama Public” from the drop-down list next to the Publish To option, if it is not already selected
    • Enter an Access Link
    • If you are submitting data for a manuscript undergoing peer review leave the Keep Private box checked. This will ensure that when the data is copied to Panorama Public, it will be kept private with read-only access to the submitter. Another read-only reviewer account will be created for the data, and account details provided to the submitter. The account details can be conveyed to the journal where the manuscript is submitted. If, however, you want your data to be publicly available on Panorama Public right away uncheck the Keep Private checkbox.
    • Click the Submit button
    Access Link is the link that you will include in your manuscript to link to supplementary data on Panorama Public that can be viewed in a web browser. Initially, this link points to your folder on PanoramaWeb. But once a copy of your data has been made to Panorama Public, it will link to the location of the copied data on Panorama Public. This will be the permanent location of your supplementary data on Panorama Public.

    The Publish Experiment form allows you to “build” these the access link. The initial part of the link remains constant: https://panoramaweb.org/. You can choose a string to complete the link (highlighted in yellow below).
    https://panoramaweb.org/choose_a_string.url
    The initial value entered in the Access Link field is a randomly generated alphanumeric string. You can replace it with a convenient, easy to remember string. This string has to be unique across all the experiments published to Panorama Public. You may get an error if the link you entered is already in use for another experiment on Panorama Public. If this happens change the text in the access link field and try again.

    Requests to copy data are handled by Panorama Public administrators within a week of submission. Once your data has been successfully copied to Panorama Public you will receive a confirmation email. If you requested that your data on Panorama Public be kept private (e.g. for a manuscript under peer review), the confirmation email will also include reviewer account details. You can pass on the account details to the journal where you are submitting your manuscript. The confirmation email will also include a ProteomeXchange ID unless you opted to skip ProteomeXchange submission.

    Once the form is submitted successfully you can go back to the experiment details page.

    In the Experiment Details box, just above the experiment title, you will see a “Copy Pending!” message. This message will disappear once your data has been copied to Panorama Public. Any changes that you make in the folder, such as adding/removing Skyline documents or wiki pages, or changing the layout of the page will also get copied when a copy is made to Panorama Public. At the bottom of the page, in the Submission table, you will see the Access Link that you created for this experiment. The Copied column will be blank until a copy has been made successfully. Once the data has been copied this column will display the date when the data was copied. And at that point if you click the Access Link you will be taken to the location on Panorama Public where your data was copied. You can verify that the data, folder layout and views were copied accurately.


    If you need to make any changes to your data (e.g. to address reviewer feedback) after it has been copied to Panorama Public you can make the changes in your own folder. When you are ready click the red Resubmit button in the Targeted MS Experiment web part. This will send a request to the Panorama Public administrators to delete the old copy and make a new copy of your data to Panorama Public. Your access link will remain unchanged.


    Related Resources: