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

Add documentation for Classifier Results View #88

Open
gwaybio opened this issue Oct 15, 2018 · 0 comments
Open

Add documentation for Classifier Results View #88

gwaybio opened this issue Oct 15, 2018 · 0 comments

Comments

@gwaybio
Copy link
Collaborator

gwaybio commented Oct 15, 2018

@ypar noted in #86

it would be nicer to see some summary texts accompanying them. in their current form, they are very difficult to follow. maybe show one or two exemplary figures in their respective notebooks and describe what they mean? IMHO, every notebook and figure are maximally useful only if they are interpretable as standalone documents. If I have to jump between multiple notebooks and search scripts to understand a figure, that eliminates the convenience of having notebooks published.

I need to do this. I am thinking about adding a README to the classifiers folder that will serve as a document guide.

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