Foreword

topdownr is free and open-source software. If you use it, please support the project by citing it in publications:

P.V. Shliaha, S. Gibb, V. Gorshkov, M.S. Jespersen, G.R. Andersen, D. Bailey, J. Schwartz, S. Eliuk, V. Schwämmle, and O.N. Jensen. 2018. Maximizing Sequence Coverage in Top-Down Proteomics By Automated Multi-modal Gas-phase Protein Fragmentation. Analytical Chemistry. DOI: 10.1021/acs.analchem.8b02344

Questions and bugs

For bugs, typos, suggestions or other questions, please file an issue in our tracking system (https://github.com/sgibb/topdownr/issues) providing as much information as possible, a reproducible example and the output of sessionInfo().

If you don’t have a GitHub account or wish to reach a broader audience for general questions about proteomics analysis using R, you may want to use the Bioconductor support site: https://support.bioconductor.org/.

1 Introduction

1.1 The `topdownr` Data Generation Workflow

2 Installation of Additional Software

2.1 Setup the Thermo Software

To create methods the user will have to install and modify Orbitrap Fusion LUMOS workstation first:

Request TribridSeriesWorkstationSetup-v3.2.exe from Thermo Scientific.
Install the workstation by running TribridSeriesWorkstationSetup-v3.2.exe.

2.2 Setup XMLMethodChanger

XMLMethodChanger is needed to convert the xml methods into .meth files. It could be found at https://github.com/thermofisherlsms/meth-modifications The user has to download and compile it himself (or request it from Thermo Scientific as well). You would need at least the 3.2 beta version.

2.3 Setup Operating System

In order to use XMLMethodChanger the operating system has to use the . (dot) as decimal mark and the , (comma) as digit group separator (one thousand dot two should be formated as 1,000.2).

In Windows 7 the settings are located at Windows Control Panel > Region and Language > Formats. Choose English (USA) here or use the Additional settings button to change it manually.

2.4 Setup ScanHeadsman

After data aquisition topdownr would need the header information from the .raw files. Therefore the ScanHeadsman software is used. It could be downloaded from https://bitbucket.org/caetera/scanheadsman

It requires Microsoft .NET 4.5 or later (it is often preinstalled on a typical modern Windows or could be found in Microsoft’s Download Center, e.g. https://www.microsoft.com/en-us/download/details.aspx?id=30653). Additionally you would need Thermo’s MS File Reader which could be downloaded free of charge (but you have to register) from the Thermo FlexNet website: https://thermo.flexnetoperations.com/

ScanHeadsman was created by Vladimir Gorshkov vgor@bmb.sdu.dk.

3 Creating Methods

Importantly, XMLmethodChanger does not create methods de novo, but modifies pre-existing methods (supplied with XMLMethodChanger) using modifications described in XML files. Thus the whole process of creating user specified methods consists of 2 parts:

Construction of XML files with all possible combination of fragmentation parameters (see topdownr::createExperimentsFragmentOptimisation, and topdownr::writeMethodXmls below).
Submitting the constructed XML files together with a template .meth file to XMLmethodChanger.

We choose to use targeted MS2 scans (TMS2) as a way to store the fragmentation parameters. Each TMS2 is stored in a separate experiment. Experiments do not overlap.

Method Editor

4 Data preparation with `topdownr`

Shown below is the process of creating XML files and using them to modify the TMS2IndependentTemplateForTD.meth template file.

library("topdownr")

## Create MS1 settings
ms1 <- expandMs1Conditions(
    FirstMass=400,
    LastMass=1200,
    Microscans=as.integer(10)
)

## Set TargetMass
targetMz <- cbind(mz=c(560.6, 700.5, 933.7), z=rep(1, 3))

## Set common settings
common <- list(
    OrbitrapResolution="R120K",
    IsolationWindow=1,
    MaxITTimeInMS=200,
    Microscans=as.integer(40),
    AgcTarget=c(1e5, 5e5, 1e6)
)

## Create settings for different fragmentation conditions
cid <- expandTms2Conditions(
    MassList=targetMz,
    common,
    ActivationType="CID",
    CIDCollisionEnergy=seq(7, 35, 7)
)
hcd <- expandTms2Conditions(
    MassList=targetMz,
    common,
    ActivationType="HCD",
    HCDCollisionEnergy=seq(7, 35, 7)
)
etd <- expandTms2Conditions(
    MassList=targetMz,
    common,
    ActivationType="ETD",
    ETDReactionTime=as.double(1:2)
)
etcid <- expandTms2Conditions(
    MassList=targetMz,
    common,
    ActivationType="ETD",
    ETDReactionTime=as.double(1:2),
    ETDSupplementalActivation="ETciD",
    ETDSupplementalActivationEnergy=as.double(1:2)
)
uvpd <- expandTms2Conditions(
    MassList=targetMz,
    common,
    ActivationType="UVPD"
)

## Create experiments with all combinations of the above settings
## for fragment optimisation
exps <- createExperimentsFragmentOptimisation(
    ms1=ms1, cid, hcd, etd, etcid, uvpd,
    groupBy=c("AgcTarget", "replication"), nMs2perMs1=10, scanDuration=0.5,
    replications=2, randomise=TRUE
)

## Write experiments to xml files
writeMethodXmls(exps=exps)

## Run XMLMethodChanger
runXmlMethodChanger(
    modificationXml=list.files(pattern="^method.*\\.xml$"),
    templateMeth="TMS2IndependentTemplateForTD.meth",
    executable="path\\to\\XmlMethodChanger.exe"
)

5 Data Acquisition

After setting up direct infusion make sure that MS1 spectrum produces expected protein mass after deconvolution by Xtract. Shown below is a deconvoluted MS1 spectrum for myoglobin. The dominant mass corresponds to myoglobin with Met removed.

Xtract myoglobin

6 Data Preparation

Prior to R analysis of protein fragmentation data we have to convert the .raw files.

6.1 Extracting Header Information

Some of the information (SpectrumId, Ion Injection Time (ms), Orbitrap Resolution, targeted Mz, ETD reaction time, CID activation and HCD activation) is stored in scan headers, while other (ETD reagent target and AGC target) is only available in method table.

You can run ScanHeadsman from the commandline (ScanHeadsman.exe --noMS --methods:CSV) or use the function provided by topdownr:

runScanHeadsman(
    path="path\\to\\raw-files",
    executable="path\\to\\ScanHeadsman.exe"
)

ScanHeadsman will generate a .txt (scan header table) and a .csv (method table) file for each .raw file.

6.2 Convert .raw files into mzML

The spectra have to be charge state deconvoluted with Xtract node in Proteome Discoverer 2.1. The software returns deconvoluted spectra in mzML format.

Proteome Discoverer

Once a .csv, .txt, and .mzML file for each .raw have been produced we can start the analysis using topdownr. Please see analysis vignette (vignette("analysis", package="topdownr")) for an example.

7 Session Info

sessionInfo()

## R version 4.3.1 (2023-06-16)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 22.04.3 LTS
## 
## Matrix products: default
## BLAS:   /home/biocbuild/bbs-3.18-bioc/R/lib/libRblas.so 
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.10.0
## 
## locale:
##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
##  [3] LC_TIME=en_GB              LC_COLLATE=C              
##  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8   
##  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C                 
##  [9] LC_ADDRESS=C               LC_TELEPHONE=C            
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       
## 
## time zone: America/New_York
## tzcode source: system (glibc)
## 
## attached base packages:
## [1] stats4    stats     graphics  grDevices utils     datasets  methods  
## [8] base     
## 
## other attached packages:
##  [1] ggplot2_3.4.4       ranger_0.15.1       topdownrdata_1.23.0
##  [4] topdownr_1.24.0     Biostrings_2.70.0   GenomeInfoDb_1.38.0
##  [7] XVector_0.42.0      IRanges_2.36.0      S4Vectors_0.40.0   
## [10] ProtGenerics_1.34.0 BiocGenerics_0.48.0 BiocStyle_2.30.0   
## 
## loaded via a namespace (and not attached):
##  [1] tidyselect_1.2.0        farver_2.1.1            dplyr_1.1.3            
##  [4] bitops_1.0-7            fastmap_1.1.1           RCurl_1.98-1.12        
##  [7] XML_3.99-0.14           digest_0.6.33           lifecycle_1.0.3        
## [10] cluster_2.1.4           statmod_1.5.0           magrittr_2.0.3         
## [13] compiler_4.3.1          rlang_1.1.1             sass_0.4.7             
## [16] tools_4.3.1             utf8_1.2.4              yaml_2.3.7             
## [19] knitr_1.44              labeling_0.4.3          plyr_1.8.9             
## [22] BiocParallel_1.36.0     withr_2.5.1             grid_4.3.1             
## [25] preprocessCore_1.64.0   fansi_1.0.5             colorspace_2.1-0       
## [28] scales_1.2.1            iterators_1.0.14        MASS_7.3-60            
## [31] cli_3.6.1               mzR_2.36.0              rmarkdown_2.25         
## [34] crayon_1.5.2            generics_0.1.3          ncdf4_1.21             
## [37] cachem_1.0.8            affy_1.80.0             zlibbioc_1.48.0        
## [40] parallel_4.3.1          impute_1.76.0           BiocManager_1.30.22    
## [43] vsn_3.70.0              vctrs_0.6.4             Matrix_1.6-1.1         
## [46] jsonlite_1.8.7          bookdown_0.36           MALDIquant_1.22.1      
## [49] clue_0.3-65             magick_2.8.1            foreach_1.5.2          
## [52] limma_3.58.0            jquerylib_0.1.4         affyio_1.72.0          
## [55] glue_1.6.2              MSnbase_2.28.0          codetools_0.2-19       
## [58] gtable_0.3.4            mzID_1.40.0             munsell_0.5.0          
## [61] tibble_3.2.1            pillar_1.9.0            pcaMethods_1.94.0      
## [64] htmltools_0.5.6.1       GenomeInfoDbData_1.2.11 R6_2.5.1               
## [67] doParallel_1.0.17       evaluate_0.22           lattice_0.22-5         
## [70] Biobase_2.62.0          bslib_0.5.1             Rcpp_1.0.11            
## [73] xfun_0.40               MsCoreUtils_1.14.0      pkgconfig_2.0.3

Data Generation for topdownr

24 October 2023

Abstract

Package

Foreword

Questions and bugs

1 Introduction

1.1 The `topdownr` Data Generation Workflow

2 Installation of Additional Software

2.1 Setup the Thermo Software

2.2 Setup XMLMethodChanger

2.3 Setup Operating System

2.4 Setup ScanHeadsman

3 Creating Methods

4 Data preparation with `topdownr`

5 Data Acquisition

6 Data Preparation

6.1 Extracting Header Information

6.2 Convert .raw files into mzML

7 Session Info

8 References

Data Generation for topdownr

24 October 2023

Abstract

Package

Foreword

Questions and bugs

1 Introduction

1.1 The topdownr Data Generation Workflow

2 Installation of Additional Software

2.1 Setup the Thermo Software

2.2 Setup XMLMethodChanger

2.3 Setup Operating System

2.4 Setup ScanHeadsman

3 Creating Methods

4 Data preparation with topdownr

5 Data Acquisition

6 Data Preparation

6.1 Extracting Header Information

6.2 Convert .raw files into mzML

7 Session Info

8 References

1.1 The `topdownr` Data Generation Workflow

4 Data preparation with `topdownr`