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

documentation for the data module #50

Closed
aryarm opened this issue Jun 17, 2022 · 1 comment · Fixed by #67
Closed

documentation for the data module #50

aryarm opened this issue Jun 17, 2022 · 1 comment · Fixed by #67
Labels
documentation Improvements or additions to documentation

Comments

@aryarm
Copy link
Member

aryarm commented Jun 17, 2022

we already have the automatically generated documentation in the API section

but it would be nice if we had a basic tutorial page sorta like pysam's

specifically, we should discuss

  • how to instantiate an instance
  • what kinds of properties each class has
  • how to read a file
    • and how to iterate over a file
  • a brief overview of some of the methods in each class
  • how to write a file
  • how to extend each class to create your own custom classes

For the Haplotypes class, we should be able to more-or-less copy the Details section of #43

@aryarm aryarm added the documentation Improvements or additions to documentation label Jun 17, 2022
@aryarm
Copy link
Member Author

aryarm commented Jul 20, 2022

Resolved by #67

@aryarm aryarm closed this as completed Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant