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

indices and leaflet_var params #4

Closed
thomasstjerne opened this issue Sep 29, 2022 · 2 comments
Closed

indices and leaflet_var params #4

thomasstjerne opened this issue Sep 29, 2022 · 2 comments

Comments

@thomasstjerne
Copy link

I have a couple of questions

  1. Is it correct that omitting the --indices param will make the pipeline default to all indices?
  2. If so, and the pipeline is started with only a few indices, like --indices calc_richness,calc_phylo_rpd1 is it correct that the user then also needs to adjust the --leaflet_var param, otherwise some input data will be missing for that step?

If this is correctly understood, is it possible to get a mapping of --leaflet_var values to which indices they depend on?

Best,
Thomas

@vmikk
Copy link
Owner

vmikk commented Sep 29, 2022

Hello Thomas!

That is correct, --leaflet_var depends on --indices.
Essentially, indices must be chosen at the step when we estimate diversity with Biodiverse.
Biodiverse supports ~380 indices.
By default, we estimate the most essential ones (e.g., species richness, PD, phylogenetic endemism).
At the visualization step, we can show only the indices present in the resulting table.
In addition, for some of the indices, there could be standardized effect sizes (SES, a.k.a. Z-scores). Biodiverse provides them using the same name but in a different table. To visualize them, we must add SES_ prefix to the index name (e.g., SES_PD).
Currently, there is no "compatibility" validation of index names specified with these two parameters (missing indices just would not be displayed).

However, we can create a mapping file. Is there a preferred format for it?

With kind regards,
Vladimir

PS. In Biodiverse, indices are organized into modules (subroutines).
So specifying --indices "calc_pd" will provide estimates for 4 indices (PD, PD_P, PD_P_per_taxon, PD_per_taxon) plus their effect sizes (SES_*) which could be visualized.

@vmikk
Copy link
Owner

vmikk commented Nov 8, 2022

Schema file describing the parameters and possible options for some of those:
https://github.com/vmikk/PhyloNext/blob/main/nextflow_schema.json
(still a work-in-progress)

@vmikk vmikk closed this as completed Feb 3, 2023
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

2 participants