Skip to content
Kevin Kovalchik edited this page Jun 28, 2019 · 8 revisions

RawTools

Welcome to the RawTools wiki! On this page you will find information related to using RawTools, and helpful documents to aid in making sense of the output. If you notice anything missing from this page or you encounter any issues with RawTools, please do not hesitate to make a post on the Issues page.


Installation and Use Guides

These guides have been separated by operating system to make them easier to follow. Find your operating system and follow through the guides to start using RawTools!

Please note that, unlike MSFileReader, the new RawFileReader from Thermo Fisher does not require a separate installation.

Minimum/Recommended System Requirements

RawTools requires a 64-bit operating system.

There are no real minimum requirements in terms of processor speed, hard drive space or RAM. However, to increase processing speed, significant portions of the raw file are extracted into memory, so your RAM needs will scale with the size of raw file with which you are working. For very large raw files (>~2GB) the memory usage can become quite high. Even when the memory usage exceeds your physical RAM, there is usually enough virtual memory or swap space to process these large files, but things will get slower. If you deal with very very large files (>5GB) you run a real risk of running out of virtual memory or swap space, so, if you run into problems, increasing these values might help.

Windows

RawTools requires .NET 4.6.2 or greater, and thus the operating system requirements are based on the requirements of this package.

  1. Download and install .NET 4.6.2 from Microsoft for Windows.
  2. Download and prepare RawTools for Windows.
  3. Optional: download a test dataset for processing with RawTools for Windows.
  4. Optional: download and prepare X! Tandem
  5. Run RawTools for parsing and quantification for Windows.
  6. Run RawTools for quality control for Windows.

Linux

For Linux, we will be using a CentOS 7 system. RawTools requires the use of Mono as a .NET package on Linux.

  1. Download and install Mono for Linux.
  2. Download and prepare RawTools for Linux.
  3. Optional: download a test dataset for processing with RawTools for Linux.
  4. Optional: download and prepare X! Tandem
  5. Run RawTools for parsing and quantification for Linux.
  6. Run RawTools for quality control for Linux.

MacOS

For MacOS, we will be using a MacBook Air system ('High Sierra' 10.13.1). RawTools requires Mono as a .NET package on MacOS.

  1. Download and install Mono for MacOS.
  2. Download and prepare RawTools for MacOS.
  3. Optional: download a test dataset for processing with RawTools for MacOS.
  4. Optional: download and prepare X! Tandem
  5. Run RawTools for parsing and quantification for MacOS.
  6. Run RawTools for quality control for MacOS.

Results output annotation and identifiers

If you have already processed your data with RawTools and just need help understanding what is in the output, visit the pages below describing the data.

  1. 'Metrics.txt' data output.
  2. 'Matrix.txt' data output.
  3. 'Matrix.txt with quant' data output.
  4. 'QcDataTable.csv' data output.