Skip to content

Example usage for Frag'n'Flow

István Szepesi-Nagy edited this page Sep 20, 2025 · 7 revisions
2025-09-14 22_04_01-FragFlow-subway-02_PNG

Welcome to the FragNFlow wiki!

This page provides a minimal working example of a dataset analyzed with the Frag’n’Flow pipeline.

📖_For installation instructions and full documentation, please see the README_

1. Data Access

Dataset: Label-free quantification (LFQ) based DDA proteomics data from Fragile X Syndrome (FXS) patients (Utami et al. 2020).
PRIDE accession: PXD011630

We will analyze differential protein expression between FXS and healthy samples using the following files:

20180129_QE9_nLC14_NHS_SA_50cm_Neuro_FXS_1.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuro_FXS_2.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuro_FXS_3.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuro_FXS_4.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuron_Con_1.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuron_Con_2.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuron_Con_3.raw
20180129_QE9_nLC14_NHS_SA_50cm_Neuron_Con_4.raw

Download and place the raw files into a dedicated project folder (4 FXS + 4 Control samples).

⚠️Please always follow the naming convensions for each project. Note: for these datasets the file names are already in the desired format.

2. Reference proteome

Frag'n'Flow allows either:

  • Providing a path to a downloaded FASTA file, or
  • Supplying a UniProt accession ID for automatic download.

The pipeline automatically checks whether decoy sequences and common contaminants are included, and adds them if needed.\

👣 For this example, we use the human reference proteome UP000005640.

3. Generate config file

Before running the pipeline, prepare a custom .config file with the minimal required parameters.
Example (my_config_file.config):

params.config_tools = true                                             // this is used to download licensed tools (MSFragger, IonQuant, diaTracer)
params.disable_msconvert = true                                        // In FragPipe we can use .raw files, so ignore data conversion to mzML
params.disable_fragpipe = false                                        // Use FragPipe to analyse raw files
params.disable_fp_analyst = false                                      // Generate automatic statistical report of the differential expressions

params.input_folder = '/path/to/my/input/folder'                      
params.workflow = 'LFQ-MBR'                                            // The FragPipe workflow name used
params.mode = 'DDA'                                                    // Analysis mode (DDA, DIA, or TMT)
params.fasta_file = '/path/to/my/fasta/human.fasta'                    // Path to .fasta OR UniProt id
params.ram = 16                                                        // RAM for FragPipe
params.threads = 16                                                    // Parallel jobs for FragPipe

//SLURM settings
process {
  withName:FRAGPIPE {
    executor = 'slurm'
    memory = 32.GB
    cpus = 16
  }
}
//Container engine
singularity {
  enabled = true
}

To change the container engine based on your system, refer to the Frag'n'Flow Documentation or Nextflow's Container options!

4. Run Frag'n'Flow pipeline

run ronalabrcns/FragNFlow -c my_config_file.config

5. Licensed tool download authentication

On the first run, licensed tools are downloaded from the official FragPipe server. Users must provide their details and explicitly accept FragPipe’s license terms.\

🗝️ A 2FA code will be sent to the registered email. Enter it in the terminal (blind typing)!

2025-09-18 11_36_35-2025-09-14 20_56_44-response_to_reviewers_03_BLURRED_05

6. Pipeline running

During execution, Frag’n’Flow prepares all required input files for FragPipe. In case of errors, logs can be inspected for each process.

2025-09-14 20_55_51-response_to_reviewers_03 - Word

Example: to follow the FragPipe process, check the folder work/25/88d1e6*.

Typical Nextflow project structure project:

my_project/
├── my_config_file.config
├── input_data/
│ └── *.raw files
├── work/
│ ├── 24/
│ ├── ea/
│ ├── 12/
│ └── 39/
│ └── 123456hexafeab/
│ └── .command.log 🟢
├── data/
│ ├── database/
│ ├── manifest/
│ └── workflow/
└── output/
├── fragpipe/
└── fp_analyst/

7. Examine results

Once the pipeline completes successfully, results can be found in the output/ folder:

  • FragPipe results (processed proteomics data)
  • FragPipe-Analyst results (differential expression + statistical report)
2025-09-14 21_34_52-response_to_reviewers_03 - Worddone

The fp_analyst/ folder includes:

  • A generated PDF report (summary + plots)
  • An output.csv file with the differential protein expression table

These can be further explored with your preferred statistical tools.

2025-09-14 22_22_19-FragPipe-Analyst Report 2025-09-14 22_22_38-FragPipe-Analyst Report

8. Additional Resources