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

Add packages 2023_Wang_NevaliCori-Baja & 2023_Skourtanioti_Aegean #207

Merged
merged 3 commits into from
Dec 6, 2024

Conversation

EirSkou
Copy link

@EirSkou EirSkou commented Aug 16, 2024

Checklist for

Wang et al. PNAS Isotopic and DNA analyses reveal multiscale PPNB mobility and migration across Southeastern Anatolia and the Southern Levant 2023 https://www.pnas.org/doi/abs/10.1073/pnas.2210611120

PR Checklist for a new package submission

  • 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 for their definition)
    • A reasonably filled .janno file (for a list of available fields look here and here 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.
  • 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.
  • The .janno and the .ssf files are not fully quoted, so they only use single- or double quotes ("...", '...') to enclose text fields where it is strictly necessary (i.e. their entry includes a TAB).

  • The package passes a validation with trident validate --fullGeno.

  • Large genotype data files are properly tracked with Git LFS and not directly pushed to the repository. For an instruction on how to set up Git LFS please look here. If you accidentally pushed the files the wrong way you can fix it with git lfs migrate import --no-rewrite path/to/file.bed (see here).

@stschiff
Copy link
Member

Fantastic, thanks a lot @EirSkou for submitting these two. We usually take one package per PR, but I think we can handle it in this case. I will take a look later and give some feedback.

@nevrome
Copy link
Member

nevrome commented Aug 20, 2024

@EirSkou and I realized that both of her PRs (#201 and #207) include the identical 3 commits that add both packages. To keep things simple we decided to close #201 now and only keep #207. With both packages.

@nevrome
Copy link
Member

nevrome commented Aug 20, 2024

Checklist for

Skourtanioti et al. Nat Ecol Evol Ancient DNA reveals admixture history and endogamy in the prehistoric Aegean 2023 https://www.nature.com/articles/s41559-022-01952-3

PR Checklist for a new package submission

  • 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 for their definition)
    • A reasonably filled .janno file (for a list of available fields look here and here 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.
  • 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.
  • The .janno and the .ssf files are not fully quoted, so they only use single- or double quotes ("...", '...') to enclose text fields where it is strictly necessary (i.e. their entry includes a TAB).

  • The package passes a validation with trident validate --fullGeno.

  • Large genotype data files are properly tracked with Git LFS and not directly pushed to the repository. For an instruction on how to set up Git LFS please look here. If you accidentally pushed the files the wrong way you can fix it with git lfs migrate import --no-rewrite path/to/file.bed (see here).

@nevrome nevrome changed the title Package 2023_Wang_NevaliCori-Baja for PPN, Iron Age and Roman period individuals from SE Turkey and S Jordan. Added packages 2023_Wang_NevaliCori-Baja & 2023_Skourtanioti_Aegean Aug 20, 2024
@nevrome nevrome changed the title Added packages 2023_Wang_NevaliCori-Baja & 2023_Skourtanioti_Aegean Add packages 2023_Wang_NevaliCori-Baja & 2023_Skourtanioti_Aegean Sep 6, 2024
@stschiff
Copy link
Member

stschiff commented Oct 9, 2024

I have just gone through both of these. Both packages look perfect for me. The only bit left is:

  1. The Janno checksum doesn't validate, in both cases.
  2. The Package version should be 1.0.0, but is 0.1.0

@EirSkou in order to not loose more time: If you can fix this within 1-2 days or so, go ahead, otherwise I am happy to make that fix and have @AyGhal merge this in. Any other objections?

@stschiff stschiff self-assigned this Dec 3, 2024
@stschiff
Copy link
Member

stschiff commented Dec 6, 2024

OK, I decided to merge this now into a specific branch within this user-space and make additional changes there.

@stschiff stschiff changed the base branch from master to dev December 6, 2024 14:07
@stschiff stschiff merged commit 561baff into poseidon-framework:dev Dec 6, 2024
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.

3 participants