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

Package versioning #70

Merged
merged 10 commits into from
Feb 19, 2024
Merged

Package versioning #70

merged 10 commits into from
Feb 19, 2024

Conversation

nevrome
Copy link
Member

@nevrome nevrome commented Feb 14, 2024

This PR includes a suggestion for an addition to the schema text to give some guidelines for package versioning. You may have different opinions about this, so feel free to push back. If/when this is merged, then it will close #69.

I think we could add this to 2.7.1 and treat it as a clarification that does not require a new schema release. Or we combine it with some more changes (maybe #67, #66 and #44) and actually prepare a new release.

@stschiff
Copy link
Member

I like it. I made one small change to clarify that "genotype data" means changes in the bed or geno file (because we use the term "genotype data" also sometimes for the entire triple of files.

@nevrome
Copy link
Member Author

nevrome commented Feb 15, 2024

Hm - I think I would explicitly include the .fam/.ind and .bim/.snp files here.

If somebody changes the name of a sample or a SNP then this is imho also a major change. One could discuss about sex and group names for the samples, but even there I would argue that such changes can easily break genotype data-based workflows. And that is what I think a major package version should preserve.

@stschiff
Copy link
Member

OK, but then we should say something like "genotype data (either of the three files)" or so.

@nevrome
Copy link
Member Author

nevrome commented Feb 16, 2024

I changed it now to

When genotype data (i.e. the contents of the .bed/.bim/.fam or .geno/.snp/.ind files) for any number of samples is changed.

@TCLamnidis
Copy link
Member

Then the extra point in Minor bumps about adding an individual should be removed. If the genotype dataset is changed in any way, incl. adding an ID, its a new Major v

@nevrome
Copy link
Member Author

nevrome commented Feb 16, 2024

True! And it should be, I guess.

Imagine you add a new individual for a group that is already represented in the dataset. Then the result of an analysis based on this group will change.

If this is the criterion by which we draw the line for a major change, then adding a new sample must also be a major change.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@nevrome
Copy link
Member Author

nevrome commented Feb 18, 2024

Thanks for this good review, @TCLamnidis. Very valuable!

@nevrome
Copy link
Member Author

nevrome commented Feb 19, 2024

OK - I think this is fine now. Will merge.

@nevrome nevrome merged commit 47c27dc into master Feb 19, 2024
@nevrome nevrome deleted the versioningClarification branch February 19, 2024 07:44
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.

Clarify versioning rules
3 participants