Skip to content

Commit

Permalink
embedding community archive submission checklists from PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
nevrome committed May 7, 2024
1 parent 2f9776e commit c52a856
Showing 1 changed file with 2 additions and 38 deletions.
40 changes: 2 additions & 38 deletions archive_submission_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,31 +42,7 @@ This is mandatory. Please also run [`trident validate`](trident?id=validate-comm

The community archive has some additional requirements for your package beyond what you would need to simply use the package locally for your own analysis. So the following submission **checklist** includes some of these less obvious qualities you should consider before submitting the package online, on top of what is technically necessary:

- [ ] The package does not exist already in the community archive, also not with a different name.
- [ ] The package title in the `POSEIDON.yml` conforms to the general title structure suggested here: `<Year>_<Last name of first author>_<Region, time period or special feature of the paper>`, e.g. `2021_Zegarac_SoutheasternEurope`, `2021_SeguinOrlando_BellBeaker` or `2021_Kivisild_MedievalEstonia`.
- [ ] The package is stored in a directory that is named like the package title.


- [ ] The package is complete and features the following elements:
- [ ] Genotype data in binary PLINK format (not EIGENSTRAT format).
- [ ] A `POSEIDON.yml` file with not just the file-referencing fields, but also the following meta-information fields present and filled: `poseidonVersion`, `title`, `description`, `contributor`, `packageVersion`, `lastModified` (see [here](https://github.com/poseidon-framework/poseidon-schema/blob/master/POSEIDON_yml_fields.tsv) for their definition)
- [ ] A reasonably filled `.janno` file (for a list of available fields look [here](https://github.com/poseidon-framework/poseidon-schema/blob/master/janno_columns.tsv) and [here](https://www.poseidon-adna.org/#/janno_details) for more detailed documentation about them).
- [ ] A `.bib` file with the necessary literature references for each sample in the `.janno` file.
- [ ] Every file in the submission is correctly referenced in the `POSEIDON.yml` file and there are no additional, supplementary files in the submission that are not documented there.
- [ ] Genotype data, `.janno` and `.bib` file are all named after the package title and only differ in the file extension.
- [ ] All text files are UTF-8 encoded and have Unix/Unix-like line endings (`LF`, not `CR+LF` or `CR`).
- [ ] The package version in the `POSEIDON.yml` file is `1.0.0`.
- [ ] The `poseidonVersion` of the package in the `POSEIDON.yml` file is set to the latest version of the Poseidon schema.
- [ ] The `POSEIDON.yml` file contains the corresponding checksums for the fields `genoFile`, `snpFile`, `indFile`, `jannoFile` and `bibFile`.
- [ ] There is either no `CHANGELOG` file or one with a single entry for version `1.0.0`.


- [ ] The `Publication` column in the `.janno` file is filled and the respective `.bib` file has complete entries for the listed mentioned keys.
- [ ] The `.janno` file does not include any empty columns or columns only filled with `n/a`.
- [ ] The order of columns in the `.janno` file adheres to the standard order as defined in the Poseidon schema [here](https://github.com/poseidon-framework/poseidon-schema/blob/master/janno_columns.tsv).


- [ ] The package passes a validation with `trident validate --fullGeno`.
[](https://raw.githubusercontent.com/poseidon-framework/community-archive/master/.github/PULL_REQUEST_TEMPLATE/add_package_template.md ':include')

### Submitting the package

Expand Down Expand Up @@ -156,16 +132,4 @@ Please do not wait too long (max. 2 weeks) between creation of the fork and subm

Please note the following submission **checklist** for modified packages:

- [ ] The changes maintain the structural integrity of the affected packages.
- [ ] The checksums of the modified files in the respective `POSEIDON.yml` files were adjusted properly.
- [ ] Every file in the submission is correctly referenced in the relevant `POSEIDON.yml` files and there are no additional, supplementary files in the submission that are not documented there.
- [ ] All text files are still UTF-8 encoded and have Unix/Unix-like line endings (`LF`, not `CR+LF` or `CR`).


- [ ] The `packageVersion` numbers of the affected packages were increased in their `POSEIDON.yml` files.
- [ ] The changes were documented in the respective `CHANGELOG` files. If no `CHANGELOG` files existed previously it was added here.
- [ ] The `lastModified` fields of the affected `POSEIDON.yml` files were updated.
- [ ] The `contributor` fields were updated with `name`, `email` and `orcid` of the relevant, new contributors.


- [ ] All affected packages pass a validation with `trident validate --fullGeno`.
[](https://raw.githubusercontent.com/poseidon-framework/community-archive/master/.github/PULL_REQUEST_TEMPLATE/modify_package_template.md ':include')

0 comments on commit c52a856

Please sign in to comment.