-
Notifications
You must be signed in to change notification settings - Fork 28
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
unify param def #603
unify param def #603
Conversation
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea is there. Pay attention that the classes include scalar or vector information
- character scalar
- character vector
- integer scalar
- integer vector
- numeric scalar
- numeric vector
- NULL
- logical scalar
- logical vector
- ...
Also, check that all possible classes are listed and the descriptions do not have typos or other unclear things (check also details section). Keep definitions as simple as possible without losing information.
This reference page is a mess: https://microbiome.github.io/mia/reference/index.html
Can you sort it out? You can split documenation pages if necessary. For instance if multiple functions are in same page but it might be better to have them as separate. This could be in that case if the functions are doing different things.
I am thinking especially converter's documentation (https://microbiome.github.io/mia/reference/convert.html). Is that clear? Previously, they were separated based on the class (BIOM converters were with BIOM importers, phyloseq converters were in separate page etc). We could move back to that if needed but might be good to have also other's opinions (I might be biased)
Any suggestions are welcome, and they should be easy to implement (modify only @Rdname tag)
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
Signed-off-by: Daena Rys <[email protected]>
This PR aims to harmonize the mia doc.