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

Json schema improvements #51

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

ShimiraOleg
Copy link

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/pairgenomealign branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@ShimiraOleg
Copy link
Author

I've also checked the schema_input.json and I didn't find anything that needed to be altered

Copy link
Collaborator

@charles-plessy charles-plessy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR! I agree with adding tests of file existence, but I am questioning the need for the other changes...

@@ -17,13 +17,13 @@
"format": "file-path",
"exists": true,
"schema": "assets/schema_input.json",
"mimetype": "text/csv",
"pattern": "^\\S+\\.csv$",
"pattern": "^\\S+\\.(csv|tsv|json|yaml|yml)$",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should stay restricted on .csv suffix as long as we only support the text/csv format.

@@ -152,22 +153,22 @@
},
"skip_dotplot_o2m": {
"type": "boolean",
"description": "Do not generate the one-to-many alignment dot-plot.",
"description": "This option tells the pipeline to not generate the one-to-many alignment dot-plot.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to keep the description short. Other descriptions do not start with "This option tells the pipeline to". Can you leave that change out or suggest something more specific and concise?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants