Skip to content

added citation page to docs #3143

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

Merged
merged 2 commits into from
May 7, 2025
Merged

Conversation

agladstein
Copy link
Member

Description

Added recommended citations for tskit to the docs. I modeled it after the msprime docs. These were the citations mentioned in a slack conversation.

Let me know if you want any changes to the language or any different citations.

(No associated issue)

@agladstein agladstein requested a review from petrelharp April 23, 2025 19:53
@agladstein agladstein added the documentation Documentation label Apr 23, 2025
Copy link

codecov bot commented Apr 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.60%. Comparing base (feeecb5) to head (f0af207).
Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3143      +/-   ##
==========================================
- Coverage   89.94%   89.60%   -0.35%     
==========================================
  Files          29       28       -1     
  Lines       32651    31841     -810     
  Branches     5854     5849       -5     
==========================================
- Hits        29368    28531     -837     
- Misses       1869     1880      +11     
- Partials     1414     1430      +16     
Flag Coverage Δ
c-tests 86.66% <ø> (ø)
lwt-tests 80.38% <ø> (-0.40%) ⬇️
python-c-tests 88.24% <ø> (-0.99%) ⬇️
python-tests 98.80% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 6 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@benjeffery benjeffery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!

@jeromekelleher
Copy link
Member

I'm not sure how enthusiastic I am about the Zenodo URL to be honest as it's so unstable. Given that we're going to do a tskit paper in the coming months, maybe we could just drop the Zenodo one? I don't feel strongly about it though, happy to keep as-is if others think it's important.

@agladstein
Copy link
Member Author

I've removed the zenodo citation since nobody has come to it's defense. We can always put it back in.

@benjeffery benjeffery added this pull request to the merge queue May 7, 2025
Merged via the queue into tskit-dev:main with commit c6b06b0 May 7, 2025
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants