Skip to content

Commit

Permalink
Manual manifest update (issue #19)
Browse files Browse the repository at this point in the history
  • Loading branch information
bede committed May 11, 2023
1 parent 84e6f00 commit 3c31235
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ We welcome contributions of new primer schemes! We're working to make this proce

2. Create a directory named `schemename-v1` containing a text file `info.yml` containing:
```yaml
schema_version: 2-0-0
schema_version: 0.9.0
name: schemename-v1
organism: sars-cov-2
developers:
Expand All @@ -39,18 +39,19 @@ We welcome contributions of new primer schemes! We're working to make this proce
3. Copy your scheme's BED file into this directory, naming it `primer.bed`

4. Copy your scheme's reference sequence into this directory, naming it `reference.fasta`
5. Optionally run `primaschema build schemename-v1/` to create a finished scheme bundle

5. Either **open a pull request** adding your scheme directory (e.g. inside `sars-cov-2/schemename/v1`), or else **open a GitHub issue** attaching a zip file containing your scheme.



## Tooling

The companion tool [Primaschema](https://github.com/pha4ge/primaschema) can be used to validate scheme definitions and automatically checks this repository via GitHub Actions. Primaschema adds primer and reference sequence checksums to `info.yml` at build time to help catch identical primer schemes. A six column scheme.bed file is also generated at build time for legacy tool compatibility.
The companion tool [Primaschema](https://github.com/pha4ge/primaschema) can be used to validate scheme definitions and automatically checks and updates this repository via GitHub Actions. Primaschema adds primer and reference sequence checksums to `info.yml` at build time to help catch identical primer schemes. A six column scheme.bed file is also generated at build time for legacy compatibility.



## Documented schemes (23)
## Documented schemes (24)

### SARS-CoV-2 (22)

Expand Down Expand Up @@ -83,3 +84,6 @@ The companion tool [Primaschema](https://github.com/pha4ge/primaschema) can be u

- `yale-v3`

### NiV (1)

- `nipah-v1`
17 changes: 16 additions & 1 deletion index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ organisms:
display_name: MPXV
aliases:
- Monkeypox virus
- organism: niv
display_name: NiV
aliases:
- Nipah virus
schemes:
- family: artic
organism: sars-cov-2
Expand Down Expand Up @@ -52,6 +56,10 @@ schemes:
display_name: artic-v5.2.0_400
version: v5.2.0_400
repository: https://github.com/pha4ge/primer-schemes/tree/main/sars-cov-2/artic/v5.2.0_400
- name: artic-v5.3.2_400
display_name: artic-v5.3.2_400
version: v5.3.2_400
repository: https://github.com/pha4ge/primer-schemes/tree/main/sars-cov-2/artic/v5.3.2_400
- family: eden
organism: sars-cov-2
versions:
Expand Down Expand Up @@ -90,6 +98,13 @@ schemes:
display_name: midnight-v2
version: v2
repository: https://github.com/pha4ge/primer-schemes/tree/main/sars-cov-2/midnight/v2
- family: nipah
organism: niv
versions:
- name: nipah-v1
display_name: nipah-v1
version: v1
repository: https://github.com/pha4ge/primer-schemes/tree/main/niv/nipah/v1
- family: varskip
organism: sars-cov-2
versions:
Expand All @@ -110,7 +125,7 @@ schemes:
version: vss2b
repository: https://github.com/pha4ge/primer-schemes/tree/main/sars-cov-2/varskip/vss2a
- family: yale
organism: MPXV
organism: mpxv
versions:
- name: yale-v3
display_name: yale-v3
Expand Down
2 changes: 1 addition & 1 deletion sars-cov-2/midnight/ont-v3/info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ vendors:
- organisation_name: Oxford Nanopore Technologies
kit_name: MRT001.30
amplicon_size: 1200
repository_url: https://github.com/pha4ge/primer-schemes/tree/main/sars-cov-2/midnight/v3
repository_url: https://github.com/pha4ge/primer-schemes/tree/main/sars-cov-2/midnight/ont-v3
citations:
- https://dx.doi.org/10.17504/protocols.io.bwyppfvn
notes:
Expand Down

0 comments on commit 3c31235

Please sign in to comment.