Skip to content

Commit

Permalink
Merge pull request #16 from drpatelh/release
Browse files Browse the repository at this point in the history
Address review comments for v1.1 release
  • Loading branch information
ewels authored Jun 22, 2021
2 parents 3e06f50 + 8f03fa7 commit 098b8b1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The columns in the auto-created samplesheet can be tailored to be accepted out-o

3. Download the pipeline and test it on a minimal dataset with a single command:

```console
```bash
nextflow run nf-core/fetchngs -profile test,<docker/singularity/podman/shifter/charliecloud/conda/institute>
```

Expand All @@ -51,7 +51,7 @@ The columns in the auto-created samplesheet can be tailored to be accepted out-o

4. Start running your own analysis!

```console
```bash
nextflow run nf-core/fetchngs --input ids.txt -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>
```

Expand Down
6 changes: 3 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This downloads a text file called `SRR_Acc_List.txt` which can be directly provi

The typical command for running the pipeline is as follows:

```console
```bash
nextflow run nf-core/fetchngs --input ids.txt -profile docker
```

Expand All @@ -57,7 +57,7 @@ results # Finished results (configurable, see below)

When you run the above command, Nextflow automatically pulls the pipeline code from GitHub and stores it as a cached version. When running the pipeline after this, it will always use the cached version if available - even if the pipeline has been updated since. To make sure that you're running the latest version of the pipeline, make sure that you regularly update the cached version of the pipeline:

```console
```bash
nextflow pull nf-core/fetchngs
```

Expand Down Expand Up @@ -221,6 +221,6 @@ Some HPC setups also allow you to run nextflow within a cluster job submitted yo
In some cases, the Nextflow Java virtual machines can start to request a large amount of memory.
We recommend adding the following line to your environment to limit this (typically in `~/.bashrc` or `~./bash_profile`):

```console
```bash
NXF_OPTS='-Xms1g -Xmx4g'
```
2 changes: 1 addition & 1 deletion nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"sample_mapping_fields": {
"type": "string",
"fa_icon": "fas fa-globe-americas",
"description": "Comma-separated list of ENA metadata fields used to create mappings file for sample id mapping or renaming.",
"description": "Comma-separated list of ENA metadata fields used to create a separate 'id_mappings.csv' and 'multiqc_config.yml' with selected fields that can be used to rename samples in general and in MultiQC.",
"default": "run_accession,sample_accession,experiment_alias,run_alias,sample_alias,experiment_title,sample_title,sample_description,description"
},
"nf_core_pipeline": {
Expand Down

0 comments on commit 098b8b1

Please sign in to comment.