ngless-toolkit / ngless-toolkit/ngless

Update documentation for motus profiling to reflect motus2

Open
#114 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Rust
Stars
152
Forks
23
PR merge metrics
No merged PRs in 30d

Description

I noticed the documentation and template script for motus profiling seems to use motus v1 and a different, slightly more complicated approach than we're using in foundations/ngless-template-scripts

I would propose it be updated to reflect the new motus version and the simpler approach e.g. from ngless-template-scripts/motus-v2-keep-singles.ngl:

ngless "0.6"
import "motus" version "2.0"
import "parallel" version "0.6"
import "mocat" version "0.0"

num_marker_genes='3'
samples = readlines(ARGV[2])
sample = lock1(samples)
files = load_mocat_sample(ARGV[1] + '/' + sample)
files = preprocess(files, keep_singles=True) using |read|:
    read = substrim(read, min_quality=25)
    if len(read) < 45:
        discard

count = motus(files, sample=sample, n_marker_genes=num_marker_genes, relative_abundance=true)

collect(count,
        current=sample,
        allneeded=samples,
        ofile='outputs/all_samples.motusv2.relabund.tsv',
        auto_comments=[{date}, {hash}, {script}])

count_insert = motus(files, sample=sample, n_marker_genes=num_marker_genes)

collect(count_insert,
        current=sample,
        allneeded=samples,
        ofile='outputs/all_samples.motusv2.insertcount.tsv',
        auto_comments=[{date}, {hash}, {script}])

collect(qcstats({fastq}), ofile='preprocessing_fqstats.txt', current=sample, allneeded=samples)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read motus.html and examples/motus.ngl, then compare them with foundations/ngless-template-scripts/motus-v2-keep-singles.ngl. Update the documentation and template to describe the motus2 workflow and ensure the example matches the current simpler approach; done means both links show the current motus2 usage.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.