Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs & Consistency checks #370

Open
apeltzer opened this issue Aug 8, 2024 · 1 comment
Open

Update Docs & Consistency checks #370

apeltzer opened this issue Aug 8, 2024 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@apeltzer
Copy link
Member

apeltzer commented Aug 8, 2024

Description of feature

Docs should be updated and consistency checked to match pipeline

@apeltzer apeltzer added the enhancement New feature or request label Aug 8, 2024
@apeltzer apeltzer added this to the 2.4.0 milestone Aug 8, 2024
@atrigila
Copy link

I am going to add here the changes that we could do related to style and syntax according to the new specifications.

Major:

  • There are instances of params being used inside subworkflows or modules. They should be replaced by their corresponding channels.
  • Params should be defined in the pipeline initialisation workflow. This workflow should emit channels that can be passed to the main smrnaseq workflow
  • Params cannot be used outside the entry workflow

Minor:

  • Apply nf-core naming conventions for local modules/subworkflows
  • Input channel name should signify structure with the input object type
  • Each input and output channel should have a comment describing the output structure of the channel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Todo - High Priority
Development

No branches or pull requests

2 participants