Mercurial > repos > q2d2 > qiime2__longitudinal__linear_mixed_effects
view qiime2__longitudinal__linear_mixed_effects.xml @ 5:d10f755328ea draft default tip
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__longitudinal commit 5f71b597c9495eae67a447744fded834f56ca1f7
author | q2d2 |
---|---|
date | Wed, 30 Oct 2024 19:53:07 +0000 |
parents | d67d2a61549b |
children |
line wrap: on
line source
<?xml version='1.0' encoding='utf-8'?> <!-- Copyright (c) 2024, QIIME 2 development team. Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause) --> <!-- This tool was automatically generated by: q2galaxy (version: 2024.10.0) for: qiime2 (version: 2024.10.1) --> <tool name="qiime2 longitudinal linear-mixed-effects" id="qiime2__longitudinal__linear_mixed_effects" version="2024.10.0+q2galaxy.2024.10.0" profile="22.05" license="BSD-3-Clause"> <description>Linear mixed effects modeling</description> <xrefs> <xref type="bio.tools">qiime2</xref> </xrefs> <requirements> <container type="docker">quay.io/qiime2/amplicon:2024.10</container> </requirements> <version_command>q2galaxy version longitudinal</version_command> <command detect_errors="exit_code">q2galaxy run longitudinal linear_mixed_effects '$inputs'</command> <configfiles> <inputs name="inputs" data_style="staging_path_and_source_path"/> </configfiles> <inputs> <repeat name="metadata" min="1" help="[required] Sample metadata file containing individual_id_column." title="metadata: Metadata"> <conditional name="__q2galaxy__GUI__conditional__metadata__"> <param name="type" type="select" label="metadata: Metadata"> <option value="tsv" selected="true">Metadata from TSV</option> <option value="qza">Metadata from Artifact</option> </param> <when value="tsv"> <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/> </when> <when value="qza"> <param name="source" type="data" format="qza" label="Metadata Source"/> </when> </conditional> </repeat> <param name="state_column" type="text" label="state_column: Str" help="[required] Metadata column containing state (time) variable information."> <sanitizer> <valid initial="string.printable"/> </sanitizer> <validator type="expression" message="Please verify this parameter.">value is not None and len(value) > 0</validator> </param> <param name="individual_id_column" type="text" label="individual_id_column: Str" help="[required] Metadata column containing IDs for individual subjects."> <sanitizer> <valid initial="string.printable"/> </sanitizer> <validator type="expression" message="Please verify this parameter.">value is not None and len(value) > 0</validator> </param> <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options"> <param name="table" type="data" format="qza" optional="true" label="table: FeatureTable[RelativeFrequency]" help="[optional] Feature table containing metric."> <options options_filter_attribute="metadata.semantic_type"> <filter type="add_value" value="FeatureTable[RelativeFrequency]"/> </options> <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[RelativeFrequency]']</validator> </param> <conditional name="__q2galaxy__GUI__conditional__metric__" label="metric: Str"> <param name="__q2galaxy__GUI__select__" type="select" label="metric: Str" help="[optional] Dependent variable column name. Must be a column name located in the metadata or feature table files."> <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option> <option value="__q2galaxy__::control::provide">Provide a value</option> </param> <when value="__q2galaxy__::control::default"> <param name="metric" type="hidden" value="__q2galaxy__::literal::None"/> </when> <when value="__q2galaxy__::control::provide"> <param name="metric" type="text"> <sanitizer> <valid initial="string.printable"/> </sanitizer> </param> </when> </conditional> <conditional name="__q2galaxy__GUI__conditional__group_columns__" label="group_columns: Str"> <param name="__q2galaxy__GUI__select__" type="select" label="group_columns: Str" help="[optional] Comma-separated list (without spaces) of metadata columns to use as independent covariates used to determine mean structure of "metric"."> <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option> <option value="__q2galaxy__::control::provide">Provide a value</option> </param> <when value="__q2galaxy__::control::default"> <param name="group_columns" type="hidden" value="__q2galaxy__::literal::None"/> </when> <when value="__q2galaxy__::control::provide"> <param name="group_columns" type="text"> <sanitizer> <valid initial="string.printable"/> </sanitizer> </param> </when> </conditional> <conditional name="__q2galaxy__GUI__conditional__random_effects__" label="random_effects: Str"> <param name="__q2galaxy__GUI__select__" type="select" label="random_effects: Str" help="[optional] Comma-separated list (without spaces) of metadata columns to use as independent covariates used to determine the variance and covariance structure (random effects) of "metric". To add a random slope, the same value passed to "state_column" should be passed here. A random intercept for each individual is set by default and does not need to be passed here."> <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option> <option value="__q2galaxy__::control::provide">Provide a value</option> </param> <when value="__q2galaxy__::control::default"> <param name="random_effects" type="hidden" value="__q2galaxy__::literal::None"/> </when> <when value="__q2galaxy__::control::provide"> <param name="random_effects" type="text"> <sanitizer> <valid initial="string.printable"/> </sanitizer> </param> </when> </conditional> <param name="palette" type="select" label="palette: Str % Choices('Set1', 'Set2', 'Set3', 'Pastel1', 'Pastel2', 'Paired', 'Accent', 'Dark2', 'tab10', 'tab20', 'tab20b', 'tab20c', 'viridis', 'plasma', 'inferno', 'magma', 'terrain', 'rainbow', 'cividis')"> <option value="Set1" selected="true">Set1</option> <option value="Set2">Set2</option> <option value="Set3">Set3</option> <option value="Pastel1">Pastel1</option> <option value="Pastel2">Pastel2</option> <option value="Paired">Paired</option> <option value="Accent">Accent</option> <option value="Dark2">Dark2</option> <option value="tab10">tab10</option> <option value="tab20">tab20</option> <option value="tab20b">tab20b</option> <option value="tab20c">tab20c</option> <option value="viridis">viridis</option> <option value="plasma">plasma</option> <option value="inferno">inferno</option> <option value="magma">magma</option> <option value="terrain">terrain</option> <option value="rainbow">rainbow</option> <option value="cividis">cividis</option> </param> <param name="lowess" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="lowess: Bool" help="[default: No] Estimate locally weighted scatterplot smoothing. Note that this will eliminate confidence interval plotting."/> <param name="ci" type="float" min="0" max="99.999999" value="95" label="ci: Float % Range(0, 100)" help="[default: 95] Size of the confidence interval for the regression estimate."/> <conditional name="__q2galaxy__GUI__conditional__formula__" label="formula: Str"> <param name="__q2galaxy__GUI__select__" type="select" label="formula: Str" help="[optional] R-style formula to use for model specification. A formula must be used if the "metric" parameter is None. Note that the metric and group columns specified in the formula will override metric and group columns that are passed separately as parameters to this method. Formulae will be in the format "a ~ b + c", where "a" is the metric (dependent variable) and "b" and "c" are independent covariates. Use "+" to add a variable; "+ a:b" to add an interaction between variables a and b; "*" to include a variable and all interactions; and "-" to subtract a particular term (e.g., an interaction term). See https://patsy.readthedocs.io/en/latest/formulas.html for full documentation of valid formula operators. Always enclose formulae in quotes to avoid unpleasant surprises."> <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option> <option value="__q2galaxy__::control::provide">Provide a value</option> </param> <when value="__q2galaxy__::control::default"> <param name="formula" type="hidden" value="__q2galaxy__::literal::None"/> </when> <when value="__q2galaxy__::control::provide"> <param name="formula" type="text"> <sanitizer> <valid initial="string.printable"/> </sanitizer> </param> </when> </conditional> </section> </inputs> <outputs> <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/> </outputs> <tests/> <help> QIIME 2: longitudinal linear-mixed-effects ========================================== Linear mixed effects modeling Outputs: -------- :visualization.qzv: <no description> | Description: ------------ Linear mixed effects models evaluate the contribution of exogenous covariates "group_columns" and "random_effects" to a single dependent variable, "metric". Perform LME and plot line plots of each group column. A feature table artifact is required input, though whether "metric" is derived from the feature table or metadata is optional. | </help> <citations> <citation type="bibtex">@inproceedings{cite1, author = {Seabold, Skipper and Perktold, Josef}, booktitle = {Proceedings of the 9th Python in Science Conference}, organization = {SciPy society Austin}, pages = {61}, title = {Statsmodels: Econometric and statistical modeling with python}, volume = {57}, year = {2010} } </citation> <citation type="doi">10.1128/mSystems.00219-18</citation> <citation type="doi">10.1038/s41587-019-0209-9</citation> </citations> </tool>