Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tutkuyaras authored Jan 5, 2025
1 parent 6e679b5 commit 042c9a3
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ PGSXplorer includes a comprehensive pipeline that begins with rigorous quality c
## Computational Requirements
Our tool is designed to work seamlessly on Linux-based local machines, as well as in HPC and cloud environments. To run the workflow, users need to have Nextflow and Docker installed on their systems.
For those who prefer not to use Docker, the required tools must be pre-installed on their system for the corresponding functions. Please refer to the table below for the list of tools needed for each step of the workflow. Please ensure that the versions of the tools installed are compatible with the workflow requirements. Detailed installation instructions for each tool can be found in their respective official documentation.
Computational metrics including CPU utilization, memory consumption and execution time for each module of PGSXplorer have been systematically captured using the Nextflow parameters.These metrics provide detailed insight into the computational performance of the pipeline.
Computational metrics including CPU utilization, memory consumption and execution time for each module of PGSXplorer have been systematically captured using the Nextflow parameters.These metrics provide detailed insight into the computational performance of the pipeline. Nextflow reports produced for sample data sets can be found [here] (https://drive.google.com/drive/folders/1u6iAEZaDpq9U-EfrRNv2fZLEW-WXBPM2?usp=drive_link).

```
nextflow run main.nf -with-report pipeline_report.html and -with-timeline timeline.html
Expand All @@ -61,7 +61,7 @@ nextflow run main.nf -with-report pipeline_report.html and -with-timeline timeli
|-------------|------------------------------------|-------------------------------------------------|
|Imputation | Genotype Imputation | Beagle |
|-------------|------------------------------------|-------------------------------------------------|
|PGS | Single Ancestry | LDPred2, PRSice2,Lassosum 2, SBayesR-C, MegaPRS |
|PGS | Single Ancestry | LDPred2, PRSice2,Lassosum 2, MegaPRS, SBayesR-C |
|-------------|------------------------------------|-------------------------------------------------|
|PGS | Multi Ancestry | MUSSEL, PRS-CSx |
|-------------|------------------------------------|-------------------------------------------------|
Expand Down Expand Up @@ -107,14 +107,15 @@ To enable this SLURM executor, you can set process.executor = 'slurm' in the nex

### Parameters
```
// Help Flag
--help = false
Required Arguments:
--vcf_to_plink = false
--target = "$PWD/target/"
--target_prefix = "$PWD/target/target"
--target_qc_prefix = "$PWD/outputs/target_9"
--target_qc_prefix = "$PWD/outputs/last"
--pheno_file = "$PWD/target/phenotype_file_t2.txt" // Default phenotype file
--gwas_sumstat = "$PWD/target/GWAS_sumstat_t1.txt" // Default GWAS summary statistics file
--mega_summaries = "$PWD/outputs/quant.summaries"
Expand Down

0 comments on commit 042c9a3

Please sign in to comment.