Skip to content

Commit b736eb2

Browse files
authored
Update README.md
1 parent 8d9bb43 commit b736eb2

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ nf-core list
8585
To simplify the process, a `scr/fetch-data.sh` script provides a safe and efficient method for fetching data
8686

8787
```
88-
bash fetch-data.sh -i Astro_IDs.txt -t sra -p 8 -m 230 -n Astrocyte -x n
88+
bash fetch-data.sh -i IDs.txt -t sra -n rnaseq -o results -p 16 -m 250 -x n
8989
```
9090

9191

@@ -99,13 +99,18 @@ bash fetch-data.sh -i Astro_IDs.txt -t sra -p 8 -m 230 -n Astrocyte -x n
9999

100100
- `-t:` Specifies the type of identifier provided: `sra`, `synapse`
101101

102+
- `-n:` Samplesheet name for direct use with the nf-core/rna-seq pipeline will be created (CSV) `rnaseq`
103+
104+
- `-o:` The output directory where the results will be saved
105+
106+
107+
### **Optional**
108+
102109
- `-p:` CPUs
103110

104111
- `-m:` Max memory to be used
105112

106-
- `-n:` Samplesheet name for direct use with the nf-core/rna-seq pipeline will be created (CSV)
107-
108-
- `-x: ` This execution is a resume of a previous run or it is a new run. The options are: `y` or `n`
113+
- `-x:` This execution is a resume of a previous run or it is a new run. The options are: `y` or `n`
109114

110115

111116

@@ -117,13 +122,13 @@ The Nextflow `-bg` flag launches Nextflow in the background or alternatively, yo
117122

118123
## **Result**
119124

120-
The script will create a local directory based on the type identifier provided. Within this directory, the following will be found
125+
The script will create a local directory based on the given output name showing the following folders:
121126

122-
- `result:` Contains metadata and raw FASTQC files
127+
- `output_name:` Contains metadata and raw FASTQC files
123128

124129
- `work:` Contains the main pipeline workflows
125130

126-
- `20220113-001006.COMMAND:` Contains the commands used for the actual launch. File name contains the date (%y%m%d) and the time (%H%M%S) when the command was last run. Thus, if it is resumed, it will be overwritten
131+
- `20220113-001006.COMMAND:` Contains the commands used for the actual launch. File name contains the date (%y%m%d) and the time (%H%M%S) when the command was last run.
127132

128133

129134

0 commit comments

Comments
 (0)