|
1 | | -# Example commands of using pepATAC through pypiper. |
2 | | -# For the example commands of using pepATAC with looper, please see the xxx Users Guide. |
| 1 | +# Example commands of using PEPATAC through pypiper. |
| 2 | +# For the example commands of using PEPATAC with looper, please see the xxx Users Guide. |
3 | 3 |
|
4 | 4 | INPUT=/path/to/sequencing_results/fastq_files |
5 | 5 |
|
6 | | -# run pepATAC on a human paired-end reads dataset using 5 threads: |
7 | | -python pipelines/ATACseq.py -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $INPUT/ATACseq_results_PE_R1.fastq.gz -I2 $INPUT/ATACseq_results_PE_R2.fastq.gz |
| 6 | +# run PEPATAC on a human paired-end reads dataset using 5 threads: |
| 7 | +python pipelines/pepatac.py -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $INPUT/pepatac_results_PE_R1.fastq.gz -I2 $INPUT/pepatac_results_PE_R2.fastq.gz |
8 | 8 |
|
9 | | -# run pepATAC on multiple datasets at the same time: <- this could be wrong as I don't see an explaination of how to use -I and -I2 with multiple samples |
10 | | -python pipelines/ATACseq.py -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $INPUT/ATACseq_results1_PE_R1.fastq.gz $INPUT/ATACseq_results2_PE_R1.fastq.gz $INPUT/ATACseq_results3_PE_R1.fastq.gz -I2 $INPUT/ATACseq_results1_PE_R2.fastq.gz $INPUT/ATACseq_results2_PE_R2.fastq.gz $INPUT/ATACseq_results3_PE_R2.fastq.gz |
| 9 | +# run PEPATAC on multiple datasets at the same time: <- this could be wrong as I don't see an explaination of how to use -I and -I2 with multiple samples |
| 10 | +python pipelines/pepatac.py -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $INPUT/pepatac_results1_PE_R1.fastq.gz $INPUT/pepatac_results2_PE_R1.fastq.gz $INPUT/pepatac_results3_PE_R1.fastq.gz -I2 $INPUT/pepatac_results1_PE_R2.fastq.gz $INPUT/pepatac_results2_PE_R2.fastq.gz $INPUT/pepatac_results3_PE_R2.fastq.gz |
11 | 11 |
|
12 | 12 | # run multiple samples with a for loop: |
13 | 13 | declare -a sample_name_arr=("sample1","sample2","sample3") |
14 | 14 | for sample_name in "${sample_name_arr[@]}" |
15 | 15 | do |
16 | 16 | file1=$INPUT/{$file1}_PE_R1.fastq.gz |
17 | 17 | file2=${file1/R1/R2} |
18 | | -python pipelines/ATACseq.py -P 5 -O output_folder -S $sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $file1 -I2 $file2 |
| 18 | +python pipelines/pepatac.py -P 5 -O output_folder -S $sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $file1 -I2 $file2 |
19 | 19 | done |
20 | 20 |
|
21 | | -# run pepATAC on a mouse single-end reads dataset using 8 threads: |
22 | | -python pipelines/ATACseq.py -P 8 -O output_folder -S output_sample_name -G mm10 -Q single -C ATACseq.yaml -gs mm -I $INPUT/ATACseq_results_PE_R1.fastq.gz |
| 21 | +# run PEPATAC on a mouse single-end reads dataset using 8 threads: |
| 22 | +python pipelines/pepatac.py -P 8 -O output_folder -S output_sample_name -G mm10 -Q single -C pepatac.yaml -gs mm -I $INPUT/pepatac_results_PE_R1.fastq.gz |
23 | 23 |
|
24 | | -# run pepATAC with different trimming tools then default trimmomatic, currectly supports skewer and pyadapt: |
25 | | -python pipelines/ATACseq.py --skewer TRUE -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $INPUT/ATACseq_results_PE_R1.fastq.gz -I2 $INPUT/ATACseq_results_PE_R2.fastq.gz |
26 | | -python pipelines/ATACseq.py --pyadapt TRUE -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $INPUT/ATACseq_results_PE_R1.fastq.gz -I2 $INPUT/ATACseq_results_PE_R2.fastq.gz |
27 | | - |
28 | | -# re-run pepATAC and over-write the previous output: |
29 | | -python pipelines/ATACseq.py -N -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $INPUT/ATACseq_results_PE_R1.fastq.gz -I2 $INPUT/ATACseq_results_PE_R2.fastq.gz |
30 | | - |
31 | | -# continue to run pepATAC since a locked step (usually locked due to failure): |
32 | | -python pipelines/ATACseq.py -R -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C ATACseq.yaml -gs hs -I $INPUT/ATACseq_results_PE_R1.fastq.gz -I2 $INPUT/ATACseq_results_PE_R2.fastq.gz |
33 | | - |
34 | | - |
35 | | - |
36 | | - |
37 | | -# check xxxx for full list of parameter usage |
38 | | - |
39 | | -# full list of parameters are listed below: |
40 | | -python ATACseq.py |
41 | | -usage: ATACseq.py [-h] [-N] [-I2 INPUT_FILES2 [INPUT_FILES2 ...]] |
42 | | -[-M MEMORY_LIMIT] [-Q SINGLE_OR_PAIRED] [-S SAMPLE_NAME] |
43 | | -[-P NUMBER_OF_CORES] [-D] [-I INPUT_FILES [INPUT_FILES ...]] |
44 | | -[-F] [-R] [-C CONFIG_FILE] [-O PARENT_OUTPUT_FOLDER] |
45 | | -[-G GENOME_ASSEMBLY] [-gs GENOME_SIZE] |
46 | | -[--frip-ref-peaks FRIP_REF_PEAKS] [--pyadapt] [--skewer] |
47 | | -[--prealignments PREALIGNMENTS [PREALIGNMENTS ...]] [-V] |
48 | | - |
49 | | -Pipeline |
50 | | -optional arguments: |
51 | | --C CONFIG_FILE, --config CONFIG_FILE |
52 | | -pipeline config file in YAML format; relative paths |
53 | | -are considered relative to the pipeline script. |
54 | | -defaults to ATACseq.yaml |
55 | | --D, --dirty Make all cleanups manual |
56 | | --F, --follow Run all follow commands, even if command is not run |
57 | | ---frip-ref-peaks FRIP_REF_PEAKS |
58 | | -Reference peak set for calculating FRIP |
59 | | --G GENOME_ASSEMBLY, --genome GENOME_ASSEMBLY |
60 | | -identifier for genome assempbly (required) |
61 | | --gs GENOME_SIZE, --genome-size GENOME_SIZE |
62 | | -genome size for MACS2 |
63 | | --h, --help show this help message and exit |
64 | | --I INPUT_FILES [INPUT_FILES ...], --input INPUT_FILES [INPUT_FILES ...] |
65 | | -One or more primary input files (required) |
66 | | --I2 INPUT_FILES2 [INPUT_FILES2 ...], --input2 INPUT_FILES2 [INPUT_FILES2 ...] |
67 | | -One or more secondary input files (if they exists); |
68 | | -for example, second read in pair. |
69 | | --M MEMORY_LIMIT, --mem MEMORY_LIMIT |
70 | | -Memory string for processes that accept memory limits |
71 | | -(like java) |
72 | | --N, --new-start Fresh start mode, overwrite all |
73 | | --O PARENT_OUTPUT_FOLDER, --output-parent PARENT_OUTPUT_FOLDER |
74 | | -parent output directory of the project (required). |
75 | | --P NUMBER_OF_CORES, --cores NUMBER_OF_CORES |
76 | | -number of cores to use for parallel processes |
77 | | --Q SINGLE_OR_PAIRED, --single-or-paired SINGLE_OR_PAIRED |
78 | | -single or paired end? default: single |
79 | | --R, --recover Recover mode, overwrite locks |
80 | | --S SAMPLE_NAME, --sample-name SAMPLE_NAME |
81 | | -unique name for output subfolder and files (required) |
82 | | ---pyadapt Use pyadapter_trim for trimming? [Default: False] |
83 | | ---skewer Use skewer for trimming? [Default: False] |
84 | | ---prealignments PREALIGNMENTS [PREALIGNMENTS ...] |
85 | | -List of reference genomes to align to before primary |
86 | | -alignment. |
87 | | --V, --version show program's version number and exit' |
| 24 | +# run PEPATAC with different trimming tools then default trimmomatic, currectly supports skewer and pyadapt: |
| 25 | +python pipelines/pepatac.py --skewer TRUE -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $INPUT/pepatac_results_PE_R1.fastq.gz -I2 $INPUT/pepatac_results_PE_R2.fastq.gz |
| 26 | +python pipelines/pepatac.py --pyadapt TRUE -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $INPUT/pepatac_results_PE_R1.fastq.gz -I2 $INPUT/pepatac_results_PE_R2.fastq.gz |
88 | 27 |
|
| 28 | +# re-run PEPATAC and over-write the previous output: |
| 29 | +python pipelines/pepatac.py -N -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $INPUT/pepatac_results_PE_R1.fastq.gz -I2 $INPUT/pepatac_results_PE_R2.fastq.gz |
89 | 30 |
|
| 31 | +# continue to run PEPATAC since a locked step (usually locked due to failure): |
| 32 | +python pipelines/pepatac.py -R -P 5 -O output_folder -S output_sample_name -G hg38 -Q paired -C pepatac.yaml -gs hs -I $INPUT/pepatac_results_PE_R1.fastq.gz -I2 $INPUT/pepatac_results_PE_R2.fastq.gz |
90 | 33 |
|
0 commit comments