nf-core / nf-core/modules

New module: nucleoatac

Open
#12,914 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new module wishlist
Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Is there an existing module for this?
  • I have searched for the existing module
Is there an open PR for this?
  • I have searched for existing PRs
Is there an open issue for this?
  • I have searched for existing issues
Further Information

Hi nf-core/modules team,

I would like to contribute a new module for NucleoATAC.

Component name:
nucleoatac/run

Tool:
NucleoATAC calls nucleosome positions, nucleosome-free regions and occupancy tracks from paired-end bulk ATAC-seq data.

Bioconda package:
bioconda::nucleoatac=1.0.0

BioContainer:
quay.io/biocontainers/nucleoatac:1.0.0--py310h3479294_0

The module takes a coordinate-sorted BAM, BAM index, BED regions, reference FASTA and FASTA index, and emits NucleoATAC BED/bedGraph outputs plus diagnostic files.

Local checks:

  • nf-core modules lint nucleoatac/run --plain-text
  • result: 52 passed, 0 warnings, 0 failed
  • nf-test stub test with Docker passed

I am opening this issue to avoid duplicate work before submitting the PR.

Are you going to work on this?
  • If I'm planning to work on this module, I added myself to the Assignees to facilitate tracking who is working on the module
Software requirements (conda)
# yaml-language-server: $schema=https://raw.githubusercontent.com/nf-core/modules/master/modules/environment-schema.json

channels:
  - conda-forge
  - bioconda

dependencies:
  - bioconda::nucleoatac=1.0.0

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

Start with the nf-core module conventions for the nucleoatac/run component, then review the listed inputs and NucleoATAC BED, bedGraph, and diagnostic outputs. Run the provided nf-test Docker stub and nf-core modules lint nucleoatac/run --plain-text; done means the checks pass for the new module.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.