Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Document Augurpy #40

Open
4 tasks done
Zethson opened this issue Dec 21, 2021 · 2 comments
Open
4 tasks done

Document Augurpy #40

Zethson opened this issue Dec 21, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@Zethson
Copy link
Member

Zethson commented Dec 21, 2021

  • Document the API functions (copy structure from ehrapy @Zethson )
  • Write an example notebook and add it to a tutorials folder. Ideally show it in the documentation as well. @antschum
  • Document the technical differences and differences in result compared to the original R implementation @antschum
  • Add top level module docstrings (currently missing, see below) @antschum
    image
@Zethson Zethson added the enhancement New feature or request label Dec 21, 2021
@Zethson Zethson assigned Zethson and antschum and unassigned Zethson Dec 21, 2021
@antschum
Copy link
Collaborator

antschum commented Jan 3, 2022

Do you already have a place in mind where you want to document the technical differences? Does this do in the documentation as well? I propose I write them up and explain in the next meeting and then we can see which ones still need to be changed etc.

@Zethson
Copy link
Member Author

Zethson commented Jan 3, 2022

We might create a new *.rst file for that or simply state it in the README. Let's discuss as you suggest!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants