Workflow Type: Nextflow
Stable

Description

The workflow takes an input file with Cancer Driver Genes predictions (i.e. the results provided by a participant), computes a set of metrics, and compares them against the data currently stored in OpenEBench within the TCGA community. Two assessment metrics are provided for that predicitions. Also, some plots (which are optional) that allow to visualize the performance of the tool are generated. The workflow consists in three standard steps, defined by OpenEBench. The tools needed to run these steps must be in one or more Docker images, generated from Docker containers. Separated instances are spawned from these images for each step:

  1. Validation: the input file format is checked and, if required, the content of the file is validated (e.g check whether the submitted gene IDs exist)
  2. Metrics Computation: the predictions are compared with the 'Gold Standards' provided by the community, which results in two performance metrics - precision (Positive Predictive Value) and recall(True Positive Rate).
  3. Results Consolidation: the benchmark itself is performed by merging the tool metrics with the rest of TCGA data. The results are provided in JSON format and SVG format (scatter plot).

alt text

Data

Usage

In order to use the workflow you need to:

  • Install Nextflow, which depends on Java virtual machine (>=8 , <15 ). You can automate their installation for local testing using run_local_nextflow.bash.
  • Clone TCGA benchmarking Docker definitions repository from tag 1.0.3 in a separate directory, and build locally the three Docker images found in it, running the build.sh 1.0.3 script within that repo.
  • Run it just using either nextflow run main.nf -profile docker or ./run_local_nextflow.bash run main.nf -profile docker. Arguments specifications:
Usage:
Run the pipeline with default parameters:
nextflow run main.nf -profile docker

Run with user parameters:
nextflow run main.nf -profile docker --predictionsFile {driver.genes.file} --public_ref_dir {validation.reference.file} --participant_name {tool.name} --metrics_ref_dir {gold.standards.dir} --cancer_types {analyzed.cancer.types} --assess_dir {benchmark.data.dir} --results_dir {output.dir}

Mandatory arguments:
	--input		List of cancer genes prediction
	--community_id Name or OEB permanent ID for the benchmarking community
	--public_ref_dir  Directory with list of cancer genes used to validate the predictions
	--participant_id  Name of the tool used for prediction
	--goldstandard_dir  Dir that contains metrics reference datasets for all cancer types
	--event_id  List of types of cancer selected by the user, separated by spaces
	--assess_dir Dir where the data for the benchmark are stored

Other options:
	--validation_result	The output file where the results from validation step will be saved
	--assessment_results The output file where the results from the computed metrics step will be saved
	--aggregation_results The output file where the consolidation of the benchmark will be saved
	--statistics_results The output directory with nextflow statistics
	--outdir The output directory where the consolidation of the benchmark will be saved
	--statsdir The output directory with nextflow statistics
	--data_model_export_dir The output dir where json file with benchmarking data model contents will be saved
	--otherdir The output directory where custom results will be saved (no directory inside)
Flags:
	--help Display this message

Default input parameters and Docker images to use for each step can be specified in the config file NOTE: In order to make your workflow compatible with the OpenEBench VRE Nextflow Executor, please make sure to use the same parameter names in your workflow.

Total size: 5.47 KB
help Creators and Submitter
Creators
Submitter
Activity

Views: 482   Downloads: 7

Created: 23rd Nov 2021 at 16:55

Last updated: 29th Nov 2021 at 15:41

Last used: 27th Jan 2022 at 12:08

help Attributions

None

Version History

Version 4 (latest) Created 29th Nov 2021 at 15:21 by Laura Rodriguez-Navas

updated repository tag from 1.0.7 to 1.0.8


Open master f6d3a16

Version 3 Created 25th Nov 2021 at 13:31 by Laura Rodriguez-Navas

updated repository tag from 1.0.6 to 1.0.7


Frozen master e17c7bd

Version 2 Created 24th Nov 2021 at 14:03 by Laura Rodriguez-Navas

updated repository tag from 1.0.4 to 1.0.6


Frozen master 0bbd457

Version 1 (earliest) Created 23rd Nov 2021 at 16:55 by Laura Rodriguez-Navas

Added/updated 1 files


Frozen master 3a13322

Related items

Powered by
(v.1.12.0-master)
Copyright © 2008 - 2021 The University of Manchester and HITS gGmbH

By continuing to use this site you agree to the use of cookies