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

update analysis documentation-- especially "fingerprint" #124

Open
jeremymanning opened this issue Nov 19, 2022 · 0 comments
Open

update analysis documentation-- especially "fingerprint" #124

jeremymanning opened this issue Nov 19, 2022 · 0 comments

Comments

@jeremymanning
Copy link
Member

the API website here is out of date with the current version of quail. some of the inline documentation in the code itself is also out of date.

most of the inconsistencies won't lead to incorrect outputs, but one important update will be to correct how the "fingerprint" analysis says it runs by default vs. how it actually runs. the documentation (and comments in the code) say that the permutation version runs by default (with 1000 iterations), but in reality permutations are turned off by default (and they only run if you pass in permute=True).

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

No branches or pull requests

1 participant