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

Docs: Parameter schema #1045

Closed
ewels opened this issue Mar 3, 2022 · 4 comments · Fixed by nf-core/tools#1926 or nf-core/tools#2215
Closed

Docs: Parameter schema #1045

ewels opened this issue Mar 3, 2022 · 4 comments · Fixed by nf-core/tools#1926 or nf-core/tools#2215
Assignees

Comments

@ewels
Copy link
Member

ewels commented Mar 3, 2022

We could really do with some long-form documentation about nf-core parameter schema files.

At the top we can write DO NOT EDIT MANUALLY, USE "nf-core schema build" which will help a lot of people.

After that, should talk about:

  • General purpose
  • Function within pipelines
  • Function with nf-core launch
  • How to use nf-core schema build (from scratch and to update)
  • API spec of the different JSON schema fields
@apeltzer
Copy link
Member

  • including the docs building that was recently added.

@jenmuell
Copy link

PR created for nf-core schema build (from scratch and to update) and for the nf-core schema docs command nf-core/tools#1926

@jenmuell
Copy link

  • General purpose and function in pipelines are included at the beginning of the Pipeline schema section
  • Function with nf-core launch is mentioned in the Launch a pipeline section

@FranBonath
Copy link
Member

can this issue be closed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
5 participants