Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
7204fc6
Mention singletons are not mapped with `--skip_collapse`
jfy133 Jun 30, 2020
95f0bfb
Linting
jfy133 Jun 30, 2020
2540122
Merge pull request #488 from nf-core/dev
jfy133 Jul 6, 2020
54c2a3d
Started updating docs for latest modules
jfy133 Jul 6, 2020
b0b3b68
More tweaks to docs update
jfy133 Jul 6, 2020
793a2d9
Merge branch 'docs-updates' of github.com:nf-core/eager into docs-upd…
jfy133 Jul 6, 2020
ad1d386
Add profiles tutorial
jfy133 Jul 7, 2020
f38b43a
Linting
jfy133 Jul 7, 2020
0ed2395
Linting
jfy133 Jul 7, 2020
df398ce
MORE LINTING
jfy133 Jul 7, 2020
3ad93e6
Merge branch 'dev' into docs-updates
jfy133 Jul 7, 2020
81773bb
Add FAQ/Troubleshooting about wrapping stuff in paths
jfy133 Jul 8, 2020
6317149
Create remove
ZandraFagernas Jul 12, 2020
509c8b4
Add files via upload
ZandraFagernas Jul 12, 2020
717d7ab
Delete remove
ZandraFagernas Jul 12, 2020
7925130
Create remove
ZandraFagernas Jul 12, 2020
2dce470
Add files via upload
ZandraFagernas Jul 12, 2020
e61b4fc
Delete remove
ZandraFagernas Jul 12, 2020
6657beb
Create remove
ZandraFagernas Jul 12, 2020
7cd19a0
Add files via upload
ZandraFagernas Jul 12, 2020
4160aea
Delete remove
ZandraFagernas Jul 12, 2020
29984bd
Create remove
ZandraFagernas Jul 12, 2020
1ce093b
Add files via upload
ZandraFagernas Jul 12, 2020
ecb7c81
Delete remove
ZandraFagernas Jul 12, 2020
2a8dee1
Merge pull request #499 from ZandraFagernas/dev
jfy133 Jul 13, 2020
0f45d20
Inserted Zandra's latest images
jfy133 Jul 13, 2020
30e91c7
Update README.md
jfy133 Jul 13, 2020
80762cc
Start updating docs
jfy133 Jul 13, 2020
f06aff6
Merge branch 'docs-updates' of github.com:nf-core/eager into docs-upd…
jfy133 Jul 13, 2020
d8e6534
Create remove
ZandraFagernas Jul 13, 2020
56487d3
Add files via upload
ZandraFagernas Jul 13, 2020
3585dc5
Delete remove
ZandraFagernas Jul 13, 2020
ee880b7
Create remove
ZandraFagernas Jul 13, 2020
9a16bc9
Add files via upload
ZandraFagernas Jul 13, 2020
b32aaf8
Delete remove
ZandraFagernas Jul 13, 2020
54eabd3
Updated figure
ZandraFagernas Jul 13, 2020
bbbf086
Merge pull request #505 from ZandraFagernas/docs-updates
jfy133 Jul 13, 2020
1039601
More docs updates
jfy133 Jul 14, 2020
7b7a8e9
Right font for images, more output docs text and font license
jfy133 Jul 14, 2020
fe0692b
Missed a file
jfy133 Jul 14, 2020
a8be0ac
Add files via upload
ZandraFagernas Jul 14, 2020
fcbbf98
Add files via upload
ZandraFagernas Jul 14, 2020
2196246
Add files via upload
ZandraFagernas Jul 14, 2020
bf8e094
Merge pull request #506 from ZandraFagernas/docs-updates
jfy133 Jul 14, 2020
4a572b3
More tweaks
jfy133 Jul 14, 2020
14f207a
IMage fixes and linting
jfy133 Jul 14, 2020
73954bc
Update Sex.DetERRmine docs
TCLamnidis Jul 14, 2020
671c49f
Linting
TCLamnidis Jul 14, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ no-inline-html:
- img
- p
- kbd
- details
- summary
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ By default the pipeline currently performs the following:

Additional functionality contained by the pipeline currently includes:

#### Input

* Automatic merging of complex sequencing setups (e.g. multiple lanes, sequencing configurations, library types)

#### Preprocessing

* Illumina two-coloured sequencer poly-G tail removal (`fastp`)
Expand Down
1 change: 0 additions & 1 deletion assets/multiqc_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ top_modules:
- 'mtnucratio'
- 'qualimap'
- 'sexdeterrmine'
- 'gatk'
- 'multivcfanalyzer':
path_filters:
- '*MultiVCFAnalyzer.json'
Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ The nf-core/eager documentation is split into the following files:
1. This covers common nf-core errors
7. [Frequently Asked Questions](faq.md)
1. This covers more specific nf-core/eager errors
8. Tutorials
1. [How to write and use profiles for sharing your settings and reproducible science!](tutorial_profiles.md)
8 changes: 8 additions & 0 deletions docs/code_contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,11 @@ You then need to edit the script `bin/scrape_software_versions.py` to
2. add a HTML block entry to the `OrderedDict` for formatting in MultiQC.

> If a tool does not unfortunately offer any printing of version data, you may add this 'manually' e.g. with `echo "v1.1" > v_<YOUR_TOOL>.txt`

## Images and Figures

For all internal nf-core/eager documentation images we are using the 'Kalam' font by the Indian Type Foundry and licensed under the Open Font License.

For the overview image we follow the nf-core [style and guidelines](https://nf-co.re/developers/design_guidelines).

These can be found for download [here](https://fonts.google.com/specimen/Kalam)
24 changes: 24 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,30 @@ Specifying the version of the run you are using is highly recommended, as it hel

You can see more information on the nextflow documentation [here](https://www.nextflow.io/docs/latest/sharing.html?highlight=revision#handling-revisions).

## I am only getting output for a single sample although I specified multiple with wildcards

You must specify paths to files in quotes, otherwise your shell will evaluate any wildcards (\*) rather than Nextflow.

For example

```bash
nextflow run nf-core/eager --input /path/to/sample_*/*.fq.gz
```

Would be evaluated by your shell as

```bash
nextflow run nf-core/eager --input /path/to/sample_1/sample_1.fq.gz /path/to/sample_1/sample_1.fq.gz /path/to/sample_1/sample_1.fq.gz
```

And Nextflow will only take the first path after `--input`, ignoring the others.

On the otherhand encapsulating the path in quotes will allow Nextflow to evaluate the paths.

```bash
nextflow run nf-core/eager --input "/path/to/sample_*/*.fq.gz"
```

## I specified a module and it didn't produce the expected output

Possible options:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading