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 schema #205

Merged
merged 5 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ Thank you to everyone else that has contributed by reporting bugs, enhancements
- [[PR ##163](https://github.com/nf-core/proteinfold/pull/163)] - Fix full test CI.
- [[#150]](https://github.com/nf-core/proteinfold/issues/150)] - Add thanks to the AWS Open Data Sponsorship program in `README.md`.
- [[PR ##166](https://github.com/nf-core/proteinfold/pull/166)] - Create 2 different parameters for Colabfold and ESMfold number of recycles.
- [[PR ##205](https://github.com/nf-core/proteinfold/pull/205)] - Change input schema from `sequence,fasta` to `id,fasta`.

### Parameters

Expand Down
4 changes: 2 additions & 2 deletions assets/schema_input.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"items": {
"type": "object",
"properties": {
"sequence": {
"id": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Sequence name must be provided and cannot contain spaces",
Expand All @@ -21,6 +21,6 @@
"errorMessage": "Fasta file must be provided, cannot contain spaces and must have extension '.fa' or '.fasta'"
}
},
"required": ["sequence", "fasta"]
"required": ["id", "fasta"]
}
}
8 changes: 4 additions & 4 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ T1026,https://raw.githubusercontent.com/nf-core/test-datasets/proteinfold/testda

The samplesheet can have as many columns as you desire, however, there is a strict requirement for the first 2 columns to match those defined in the table below:

| Column | Description |
| ---------- | --------------------------------------------------------------------------------------------------- |
| `sequence` | Custom sequence name. Spaces in sequence names are automatically converted to underscores (`_`). |
| `fasta` | Full path to fasta file for the provided sequence. File has to have the extension ".fasta" or "fa". |
| Column | Description |
| ------- | --------------------------------------------------------------------------------------------------- |
| `id` | Custom sequence name. Spaces in sequence names are automatically converted to underscores (`_`). |
| `fasta` | Full path to fasta file for the provided sequence. File has to have the extension ".fasta" or "fa". |

An [example samplesheet](../assets/samplesheet.csv) has been provided with the pipeline.

Expand Down
Loading