---
title: Pipeline Documentation - nf-core Hackathon March 2022
tags: march-2022, nf-core, hackathon, progress
description: View the slide with "Slide Mode".
---

<!-- .slide: data-background="https://raw.githubusercontent.com/maxulysse/maxulysse.github.io/main/assets/img/svg/green_white_bg.svg" -->

<a href="https://www.nf-co.re"><img src="https://i.imgur.com/hEDjpCs.png" width="65%"><img></a>

## 🚀 Pipeline Documentation 🚀

_16th-18th March 2022_

This file: [https://hackmd.io/@nf-core/BylxH-Ygq/edit](https://hackmd.io/@nf-core/BylxH-Ygq/edit)

<img src="https://openmoji.org/data/color/svg/E040.svg" width=50> @nf-core / <img src="https://openmoji.org/data/color/svg/E045.svg" width=50> @nf-core

---

# Pipeline Team

---

# Tasks Ideas: Devs

- Review docs for anything missing (usage, output, JSON schema)
- Make workflow diagrams and annotated output doc images
- Write step-by-step pipeline tutorial (how to build a command)
- Update all long-form pipeline parameter help messages
- Describe which parameter of the _actual_ tool is being updated

---

# Tasks Ideas: Volunteers

General:
- Check issues on project board for missing docs!

---

# Remember

- Add yourself to Team Members
- Assign yourself on issues on the [project board](https://github.com/orgs/nf-core/projects/27/views/5)
- Post your progress here! One slide per pipeline

---

# Team Members

* [James Fellows Yates](https://github.com/jfy133) (eager, funcscan, taxprofiler)
* [Maxime Garcia](https://github.com/maxulysse) ([sarek](https://github.com/nf-core/sarek))
* Mei Wu (raredisease)
* Anders Jemt (raredisease)
* Gwenna Breton (raredisease)
* Annick Renevey (rnafusion)
* Subazini Thankaswamy Kosalai (raredisease)
* [James Chela](https://github.com/chelauk) (sarek)
* Friederike Hanssen (sarek)
* Nick Smith (Sarek)
* [Jasmin Frangenberg](https://github.com/jasmezz) (funcscan)
* [Moritz E. Beber](https://github.com/Midnighter) (funcscan, taxprofiler)
* [Louisa Perelo](https://github.com/louperelo) (funcscan)
* [Anan Ibrahim](https://github.com/Darcy220606) (funcscan)
* Sarah Guinchard (rnaseq)
* Paul Cantalupo
* [Maxime Borry](https://github.com/maxibor)
* [Alexander Peltzer](https://github.com/apeltzer)
* Xiang-Jun Lu

---

# Day One

---

# eager

- [#835](https://github.com/nf-core/eager/issues/835) Fixed PreSeq params help message [JAFY]

---

# raredisease

- [#121](https://github.com/nf-core/raredisease/issues/121) Example usage [name=Mei Wu] :heavy_check_mark:
- [#128](https://github.com/nf-core/raredisease/issues/128) docs: credits [name=Mei Wu] :heavy_check_mark:
- [#118](https://github.com/nf-core/raredisease/issues/118) Collaboration: clarify mtDNA subworkflow [name=STK,GB] :heavy_check_mark:
- [#117](https://github.com/nf-core/raredisease/issues/117) In progress flowchart [name=GB,STK] :heavy_check_mark:

---

# rnafusion

- [#209](https://github.com/nf-core/rnafusion/issues/209) Update documentation [name=AR]
- README sanitized
- TODOs checked
- Initial flowchart plans

---

# sarek

- [#502](https://github.com/nf-core/sarek/issues/502) Update nextflow.json [name=MUG]
- [#503](https://github.com/nf-core/sarek/issues/503) Tube Map [name=CJ,NS]
- started on tube map for sarek prepare indices subworkflow
- started on tube map for sarek basic mapping
- [#504](https://github.com/nf-core/sarek/issues/504) Update usage.md [name=FH]

---

# scrnaseq

- [#50](https://github.com/nf-core/scrnaseq/issues/50) Checked for missing modules [name=AP]
- [#92](https://github.com/nf-core/scrnaseq/issues/92) Discussion on new Samplesheet Format [name=GG,GS,AP]
- [#469](https://github.com/nf-core/test-datasets#469) Added new Samplesheet format to test-datasets [name=AP]

---

# funcscan

- Project Meeting
- Reviewed open PRs [name=JAFY, JF, LP]
- resolving conflicts of the new template v2.3 [name=MEB]
- [#33](https://github.com/nf-core/funcscan/issues/33) Started output documentation [name=LP]
- [#30](https://github.com/nf-core/funcscan/issues/30) Started updating work-diagram [name=AI]
- assemble info of all inputs/outputs for all modules
- switched to metro style, still need colour scheme
- [#31](https://github.com/nf-core/funcscan/issues/31) Started parameters documentation [name=JF]

---

# taxprofiler

- Project Meeting
- Started pipeline diagram [name= JAFY]

---

# rnaseq

- Added a few issues from gathered input [name= SG]

---

# mag

- [#161](https://github.com/nf-core/mag/issues/161) finished it and created [PR](https://github.com/nf-core/mag/pull/282) [name= Paul C]

---

# Day Two

---

# rnaseq

- [#788] Added an up-to-date Singularity installation tutorial since the one on Sylabs' website uses an outdated GO compiler version [name= SG]
- [#787] Clarified when it's a bad idea to use conda [name= SG]
- Made the same update to the nf-core pipeline template for future tools [name = SG]

---

# eager

- Updated MultiQC config to rename some General Stats column headers [name= JAFY]

---

# raredisease

- [#132](https://github.com/nf-core/raredisease/issues/132) schema_param: local_genomes [name=Mei Wu] :heavy_check_mark:
- [#134] (https://github.com/nf-core/raredisease/issues/134) Step by step tutorial -Mitochondria pipeline [name=Subazini TK]
- Will discuss flow chart
- integrate mito workflow
- [#133](https://github.com/nf-core/raredisease/issues/133) Organize schema and hide params with defaults for specific steps (e.g. calling step)

---

# fetchNGS

- [#80](https://github.com/nf-core/fetchngs/pull/80) Add troubleshooting section and FTP alternative docs [name= MB]

---

# kmermaid

- [#148](https://github.com/nf-core/kmermaid/pull/148) Update pipeline schema and default parameters values [name= MB]

---

# funcscan

- Remaining PRs merged (incl. new template), waiting for tests to succeed [name= JAFY, JF]
- Continue output documentation (finished second tool description - still five to go) [name= LP]
- Continue graphical pipeline diagram [name= AI]
- Fought with broken dependencies of broken tools 😭 [name=JAFY]
- Continue parameters documentation [name= JF]

---

# mag

- Fixed software version reporting issue in a PR [name=JAFY]

---

# taxprofiler

- [#20](https://github.com/nf-core/taxprofiler/issues/20) Started adding support for nanopore data
- [#3](https://github.com/nf-core/taxprofiler/issues/3) Started creating new kaiju module

---

# Day Three

---

# raredisease

- [#133](https://github.com/nf-core/raredisease/issues/133) Organize schema and hide params with defaults for specific steps (e.g. calling step)
- [137](https://github.com/nf-core/raredisease/issues/137) Update resource request in usage
- [126](https://github.com/nf-core/raredisease/issues/126) Describe samplesheet [name=AJ]:heavy_check_mark:

---

# viralrecon

- Draft pipeline diagram started [name=X-JL]


---

# rnaseq

- [#762](https://github.com/nf-core/rnaseq/issues/762) Added a warning about --skip_bbsplit staying true by default even if you provide files to the other bbsplit parameters [name=SG]

---

# rnaseq

- [#69](https://github.com/nf-core/rnaseq/issues/69) Added a link to QCfail to help with the interpretation of fastQC output and a warning about the output of SortMeRNA. Concluded it would be next to impossible to provide good/bad output examples for all tools since this can vary a lot depending on the experimental design [name=SG]

---

# rnaseq

- Started working on a metro map for the pipeline but won't be done in time for chekout 🐌 [name=SG]

---

# sarek

- [#502](https://github.com/nf-core/sarek/issues/502) Update nextflow.json [name=MUG]
- [#504](https://github.com/nf-core/sarek/issues/504) Update usage.md, finished samplesheet updates, Tutorials WIP [name=FH]

---

# sarek

- [#503](https://github.com/nf-core/sarek/issues/503) Tube Map [name=CJ,NS,MUG]
- Started on:
- prepare indices subworkflow
- basic mapping -> basic preprocessing
- Plan for overall combination of subworkflows maps


---

# scrnaseq

- Working on producing appropriate test-data for alevin-fry workflow to test required modules [name=AP]
- Using tutorial by alevin-fry team to generate what we need
- Will upload RAD file to testdata once done - can run quant afterwards

---

# taxprofiler

- Started completing test-data & documenting how generated [name=JAFY]
- Broke UNTAR/UNZIP in loads of modules [name=JAFY]
- [#23](https://github.com/nf-core/taxprofiler/issues/23) Taxprofiler can take Nanopore reads (fastq.gz) as input through sample sheet [name=LM]:heavy_check_mark:
- [#26](https://github.com/nf-core/taxprofiler/pull/26) Perform fastqc on nanopore reads before trimming [name=LM]:heavy_check_mark:
- [#1410](https://github.com/nf-core/modules/pull/1410) Centrifuge module [name=SS]:heavy_check_mark:
- [#1398](https://github.com/nf-core/modules/issues/1398) Kaiju module [name=TN]
- [#1403](https://github.com/nf-core/modules/issues/1403) MetaMaps module [name=HO]

---

# funscan

- More f*ckin' deepARG fixes[name=JAFY]
- ❤️🙏🙌 [name=JF]
- Pipeline workflow optimization [name=AI, JF]
- [#37](https://github.com/nf-core/funcscan/pull/37) Metro workflow draft: [name=AI] 

- Parameters documentation [name=JF]
- Output documentation [name=LP]
- First commit finiiished :heavy_check_mark:, PR coming in!

---

# rnafusion
- README/CITATIONS/schema: finished
- Ongoing: usage/output

---

# pangenome
- Documentation is a work in progress https://github.com/pangenome/pggb/pull/168. I am first adding documentation to PGGB. Then, I can copy it to the actual cluster-scalable nf-core pangenome pipeline.