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

QC for Chlamydomonas reinhardtii #890

Closed
14 tasks
aays opened this issue Apr 9, 2021 · 8 comments
Closed
14 tasks

QC for Chlamydomonas reinhardtii #890

aays opened this issue Apr 9, 2021 · 8 comments

Comments

@aays
Copy link
Contributor

aays commented Apr 9, 2021

PR for new species: #863

IMPLEMENTER'S NOTE: The recombination rates are from Hasan and Ness 2020, but the raw values were not published as part of the manuscript - per @jeromekelleher's advice I'll be uploading them to figshare and updating the doi.

The per-chromosome mutation rates will also hopefully be added in as a separate PR (I was just sent the data late yesterday) and I'll be asking about whether I can make those public as well - though it's not my data, so TBD!


If you volunteer to QC this species, please use the checklist below.
While this list is intended to be comprehensive, it may not be exhaustive.
Where relevant, the QC reviewer should identify that parameter values match
those given in the linked citation(s).

The QC reviewer should start a pull request that fills out the test stubs
with independently obtained values. The reviewer may look at the python code
for rationale provided in comments, but should ignore the actual code
as much as possible - comments in the code should give enough information
that it's obvious how to get the correct value from the provided references.
(In particular, we shouldn't copy-paste the value from the code into the test!)

  • Recombination rate.
    • This might be genome-wide, or per-chromosome. Both are fine.
    • Check there's a comment describing where it came from, and/or how calculated.
    • From a publication? Check the value(s) match the publication.
    • Calculated somehow? Average over a recombination map? Redo the calculation.
  • Mutation rate.
    • This might be genome-wide, or per-chromosome. Both are fine.
    • Check there's a comment describing where it came from, and/or how calculated.
    • From a publication? Check the value(s) match the publication.
    • Calculated somehow? Redo the calculation.
  • Recombination map (if present).
    • Does it match the assembly? Liftover is fine, if clearly stated.
    • Is the description/long_description a good summary of how the map was created?
  • Population size.
  • Generation time.

For each citation, check:

  • Doi link.
  • Is publication a preprint? Is there a peer-reviewed publication instead?
  • Is the year correct.
  • Is the author correct (spelling, accents/ligatures/etc.)

Citations are required for:

  • Genome reference assembly.
  • Mutation rate.
  • Recombination rate.
  • Recombination map(s) (if relevant).
  • Population size.
  • Generation time.

The final PR should:

  • fill out the test stubs
  • delete the pytest.mark.skip lines that make the tests not run
  • make sure they pass, talking to the original author to figure out discrepancies
@aays aays added the Species QC label Apr 9, 2021
@izabelcavassim
Copy link
Member

izabelcavassim commented Oct 26, 2021

Hi @aays, thanks for contributing to stdpopsim. I will be QCing your species. Do you have an update on the publication of the raw recombination data?

@izabelcavassim
Copy link
Member

izabelcavassim commented Oct 26, 2021

PR for new species: #863

IMPLEMENTER'S NOTE: The recombination rates are from Hasan and Ness 2020, but the raw values were not published as part of the manuscript - per @jeromekelleher's advice I'll be uploading them to figshare and updating the doi.

The per-chromosome mutation rates will also hopefully be added in as a separate PR (I was just sent the data late yesterday) and I'll be asking about whether I can make those public as well - though it's not my data, so TBD!

If you volunteer to QC this species, please use the checklist below. While this list is intended to be comprehensive, it may not be exhaustive. Where relevant, the QC reviewer should identify that parameter values match those given in the linked citation(s).

The QC reviewer should start a pull request that fills out the test stubs with independently obtained values. The reviewer may look at the python code for rationale provided in comments, but should ignore the actual code as much as possible - comments in the code should give enough information that it's obvious how to get the correct value from the provided references. (In particular, we shouldn't copy-paste the value from the code into the test!)

  • Recombination rate.
    It has a publication, but I can't find the raw values, so maybe can you add those raw values to figshare?

    • This might be genome-wide, or per-chromosome. Both are fine.
    • Check there's a comment describing where it came from, and/or how calculated.
    • From a publication? Check the value(s) match the publication.
    • Calculated somehow? Average over a recombination map? Redo the calculation.
  • Mutation rate.
    It matches with Ness et al 2015

    • This might be genome-wide, or per-chromosome. Both are fine.
    • Check there's a comment describing where it came from, and/or how calculated.
    • From a publication? Check the value(s) match the publication.
    • Calculated somehow? Redo the calculation.
  • Recombination map (if present).

    • Does it match the assembly? Liftover is fine, if clearly stated.
    • Is the description/long_description a good summary of how the map was created?
  • Population size.

  • Generation time.

For each citation, check:

  • Doi link.
  • Is publication a preprint? Is there a peer-reviewed publication instead?
  • Is the year correct.
  • Is the author correct (spelling, accents/ligatures/etc.)

Citations are required for:

  • Genome reference assembly.
  • Mutation rate.
  • Recombination rate.
  • Recombination map(s) (if relevant).
  • Population size
  • Generation time.
    I see that the generation is cited, but it is not explicitly written, maybe you calculated it @aays from the article?

I will create the PR once I get the raw recombination map.

The final PR should:

  • fill out the test stubs
  • delete the pytest.mark.skip lines that make the tests not run
  • make sure they pass, talking to the original author to figure out discrepancies

@aays
Copy link
Contributor Author

aays commented Oct 27, 2021

Hi @aays, thanks for contributing to stdpopsim. I will be QCing your PR. Do you have an update on the publication of the raw recombination data?

Hi @izabelcavassim, thanks for the QC! I did indeed upload the raw recombination data to figshare in #950 (the specific link can be found here). Please let me know if anything else is missing!

@izabelcavassim
Copy link
Member

Great @aays I will be looking at the figshare files and updating the values in the test scripts! Will let you know once I am done so you can have a look at that PR! Thanks!

@petrelharp
Copy link
Contributor

@aays - in #1067 @izabelcavassim wondered where the generation time estimate came from, but maybe you missed it?

@aays
Copy link
Contributor Author

aays commented Oct 30, 2021

Thanks for the heads up @petrelharp - I've added an explanation on the PR!

@izabelcavassim
Copy link
Member

can you close this @petrelharp? sorry forgot to mention in my other PR

@petrelharp
Copy link
Contributor

Yes! And gee you should be able to also. I've sent you an invite that should get you those permissions...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants