Skip to content

Add 2024 gretzinger oakhurst - #324

Merged
nevrome merged 10 commits into
masterfrom
add_2024_Gretzinger_Oakhurst
Jul 17, 2026
Merged

Add 2024 gretzinger oakhurst#324
nevrome merged 10 commits into
masterfrom
add_2024_Gretzinger_Oakhurst

Conversation

@stschiff

@stschiff stschiff commented Jun 22, 2026

Copy link
Copy Markdown
Member

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.

  • Samples that already have been published previously, and got re-analysed (e.g. re-sequenced) for the now packaged publication, have a modified Poseidon_ID of the form <Original Poseidon_ID>_<Initials of the main author>_<Year>. Re-analysed versions of I1685 (Lazaridis et al. 2016) should, for example, be assigned the IDs I1685_IL22 (Lazaridis et al. 2022) and I1685_IL25 (Lazaridis et al. 2025).

  • The package is complete and features the following elements:
    • Genotype data in binary PLINK format (not EIGENSTRAT format).
    • Genotype has been provided by the original authors of the publication describing the data.
    • 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
stschiff marked this pull request as draft June 22, 2026 19:19
@stschiff
stschiff marked this pull request as ready for review June 22, 2026 19:21
@stschiff

Copy link
Copy Markdown
Member Author

So this is ready for review in principle. Finally finished our 2024 paper on Oakhurst Rockshelter in South Africa. I have used Claude Code to test PDF and Excel extraction and Janno formatting. Of course I've heavily reviewed this and done a lot of manual adjustments, so this is as good as I'd have done it by hand, I would say.

@nevrome if you want, we can delete this branch and PR and submit this entire package into a new branch to test the new writelfs-server.

@nevrome

nevrome commented Jul 8, 2026

Copy link
Copy Markdown
Member

Nice! Thank you for preparing this package.

I noticed that the .ssf file was not referenced in the POSEIDON.yml file, so I quickly added it. Now the validation fails with the following issue:

[Warning] [2026-07-08 12:46:33] In the package described in data/2024_Gretzinger_Oakhurst/POSEIDON.yml:
[Warning] [2026-07-08 12:46:33] Cross-file consistency issue in package 2024_Gretzinger_Oakhurst: The information on UDG treatment in .janno and .ssf do not match for the individual: OAK003.B (half <> [half,minus])

@stschiff

Copy link
Copy Markdown
Member Author

Thanks. I've fixed that now.

@nevrome

nevrome commented Jul 17, 2026

Copy link
Copy Markdown
Member

I had another look and found everything satisfactory 👍

Will merge now.

@nevrome
nevrome merged commit cbb1f83 into master Jul 17, 2026
1 check passed
@nevrome
nevrome deleted the add_2024_Gretzinger_Oakhurst branch July 17, 2026 14:50
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