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

unify param def #603

Merged
merged 32 commits into from
Jul 23, 2024
Merged

unify param def #603

merged 32 commits into from
Jul 23, 2024

Conversation

Daenarys8
Copy link
Collaborator

This PR aims to harmonize the mia doc.

  • use @inheritParams
  • use template: param --> type --> def --> Default

man/agglomerate-methods.Rd Outdated Show resolved Hide resolved
Signed-off-by: Daena Rys <[email protected]>
Copy link
Contributor

@TuomasBorman TuomasBorman left a 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)

R/addAlpha.R Outdated Show resolved Hide resolved
R/addAlpha.R Outdated Show resolved Hide resolved
R/agglomerate.R Outdated Show resolved Hide resolved
R/calculateDMM.R Outdated Show resolved Hide resolved
R/calculateDMM.R Outdated Show resolved Hide resolved
R/runNMDS.R Outdated Show resolved Hide resolved
R/summaries.R Outdated Show resolved Hide resolved
R/taxonomy.R Outdated Show resolved Hide resolved
R/taxonomy.R Outdated Show resolved Hide resolved
R/taxonomy.R Show resolved Hide resolved
@Daenarys8 Daenarys8 changed the title WIP: unify param def unify param def Jul 22, 2024
@Daenarys8 Daenarys8 requested a review from antagomir July 22, 2024 13:40
@antagomir antagomir removed their request for review July 22, 2024 13:55
R/calculateJSD.R Outdated Show resolved Hide resolved
R/decontam.R Outdated Show resolved Hide resolved
R/decontam.R Outdated Show resolved Hide resolved
R/runDPCoA.R Show resolved Hide resolved
R/splitOn.R Outdated Show resolved Hide resolved
R/rarefyAssay.R Outdated Show resolved Hide resolved
R/relabundance.R Outdated Show resolved Hide resolved
R/runCCA.R Outdated Show resolved Hide resolved
R/runDPCoA.R Outdated Show resolved Hide resolved
R/runNMDS.R Outdated Show resolved Hide resolved
R/addAlpha.R Outdated Show resolved Hide resolved
R/addAlpha.R Outdated Show resolved Hide resolved
R/addAlpha.R Outdated Show resolved Hide resolved
R/addAlpha.R Outdated Show resolved Hide resolved
R/addAlpha.R Outdated Show resolved Hide resolved
R/taxonomy.R Outdated Show resolved Hide resolved
R/taxonomy.R Outdated Show resolved Hide resolved
R/convertFromBIOM.R Outdated Show resolved Hide resolved
R/convertToPhyloseq.R Outdated Show resolved Hide resolved
Signed-off-by: Daena Rys <[email protected]>
R/importMetaphlan.R Outdated Show resolved Hide resolved
R/splitOn.R Outdated Show resolved Hide resolved
NAMESPACE Outdated Show resolved Hide resolved
pkgdown/_pkgdown.yml Outdated Show resolved Hide resolved
@TuomasBorman TuomasBorman merged commit 96bddb7 into devel Jul 23, 2024
3 checks passed
@TuomasBorman TuomasBorman deleted the harm branch July 23, 2024 20:05
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

Successfully merging this pull request may close these issues.

2 participants