Skip to content

Add popgen examples to docs #361

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 4 commits into from
Nov 2, 2020
Merged

Conversation

tomwhite
Copy link
Collaborator

This is a documentation update to add some simple examples for popgen functions, and count_cohort_alleles. Also fixes some of the TODOs for #295.

@tomwhite tomwhite added the documentation Improvements or additions to documentation label Oct 29, 2020
Copy link
Collaborator

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

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

LGTM

@jeromekelleher
Copy link
Collaborator

Re the examples, do we plan on converting these to Jupyter at some point?

@tomwhite tomwhite added the auto-merge Auto merge label for mergify test flight label Nov 2, 2020
@tomwhite
Copy link
Collaborator Author

tomwhite commented Nov 2, 2020

Re the examples, do we plan on converting these to Jupyter at some point?

Do you mean having longer examples in the getting started/user guide (yes - we should do this) - or changing how we do the examples in the API doc?

@codecov-io
Copy link

codecov-io commented Nov 2, 2020

Codecov Report

Merging #361 into master will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #361   +/-   ##
=======================================
  Coverage   95.39%   95.40%           
=======================================
  Files          31       31           
  Lines        2108     2109    +1     
=======================================
+ Hits         2011     2012    +1     
  Misses         97       97           
Impacted Files Coverage Δ
sgkit/stats/aggregation.py 87.77% <ø> (ø)
sgkit/stats/popgen.py 67.74% <ø> (ø)
sgkit/variables.py 96.42% <ø> (ø)
sgkit/__init__.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update def421d...d464115. Read the comment docs.

@mergify mergify bot merged commit fe45a21 into sgkit-dev:master Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-merge Auto merge label for mergify test flight documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants