niwrap-mrtrix 0.5.0__py3-none-any.whl

niwrap_mrtrix/mrtrix/vectorstats.py

@@ -0,0 +1,585 @@
+# This file was auto generated by Styx.
+# Do not edit this file directly.
+
+import typing
+import pathlib
+from styxdefs import *
+
+VECTORSTATS_METADATA = Metadata(
+    id="a8a67c93f9ad1cdf03ad2a1e473010538e53830b.boutiques",
+    name="vectorstats",
+    package="mrtrix",
+    container_image_tag="mrtrix3/mrtrix3:3.0.4",
+)
+
+
+VectorstatsColumnParameters = typing.TypedDict('VectorstatsColumnParameters', {
+    "__STYX_TYPE__": typing.Literal["column"],
+    "path": InputPathType,
+})
+
+
+VectorstatsConfigParameters = typing.TypedDict('VectorstatsConfigParameters', {
+    "__STYX_TYPE__": typing.Literal["config"],
+    "key": str,
+    "value": str,
+})
+
+
+VectorstatsParameters = typing.TypedDict('VectorstatsParameters', {
+    "__STYX_TYPE__": typing.Literal["vectorstats"],
+    "notest": bool,
+    "errors": typing.NotRequired[str | None],
+    "exchange_within": typing.NotRequired[InputPathType | None],
+    "exchange_whole": typing.NotRequired[InputPathType | None],
+    "strong": bool,
+    "nshuffles": typing.NotRequired[int | None],
+    "permutations": typing.NotRequired[InputPathType | None],
+    "variance": typing.NotRequired[InputPathType | None],
+    "ftests": typing.NotRequired[InputPathType | None],
+    "fonly": bool,
+    "column": typing.NotRequired[list[VectorstatsColumnParameters] | None],
+    "info": bool,
+    "quiet": bool,
+    "debug": bool,
+    "force": bool,
+    "nthreads": typing.NotRequired[int | None],
+    "config": typing.NotRequired[list[VectorstatsConfigParameters] | None],
+    "help": bool,
+    "version": bool,
+    "input": InputPathType,
+    "design": InputPathType,
+    "contrast": InputPathType,
+    "output": str,
+})
+
+
+def dyn_cargs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build cargs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build cargs function.
+    """
+    return {
+        "vectorstats": vectorstats_cargs,
+        "column": vectorstats_column_cargs,
+        "config": vectorstats_config_cargs,
+    }.get(t)
+
+
+def dyn_outputs(
+    t: str,
+) -> typing.Any:
+    """
+    Get build outputs function by command type.
+    
+    Args:
+        t: Command type.
+    Returns:
+        Build outputs function.
+    """
+    return {
+    }.get(t)
+
+
+def vectorstats_column_params(
+    path: InputPathType,
+) -> VectorstatsColumnParameters:
+    """
+    Build parameters.
+    
+    Args:
+        path: add a column to the design matrix corresponding to subject\
+            element-wise values (note that the contrast matrix must include an\
+            additional column for each use of this option); the text file provided\
+            via this option should contain a file name for each subject.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "column",
+        "path": path,
+    }
+    return params
+
+
+def vectorstats_column_cargs(
+    params: VectorstatsColumnParameters,
+    execution: Execution,
+) -> list[str]:
+    """
+    Build command-line arguments from parameters.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Command-line arguments.
+    """
+    cargs = []
+    cargs.append("-column")
+    cargs.append(execution.input_file(params.get("path")))
+    return cargs
+
+
+def vectorstats_config_params(
+    key: str,
+    value: str,
+) -> VectorstatsConfigParameters:
+    """
+    Build parameters.
+    
+    Args:
+        key: temporarily set the value of an MRtrix config file entry.
+        value: temporarily set the value of an MRtrix config file entry.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "config",
+        "key": key,
+        "value": value,
+    }
+    return params
+
+
+def vectorstats_config_cargs(
+    params: VectorstatsConfigParameters,
+    execution: Execution,
+) -> list[str]:
+    """
+    Build command-line arguments from parameters.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Command-line arguments.
+    """
+    cargs = []
+    cargs.append("-config")
+    cargs.append(params.get("key"))
+    cargs.append(params.get("value"))
+    return cargs
+
+
+class VectorstatsOutputs(typing.NamedTuple):
+    """
+    Output object returned when calling `vectorstats(...)`.
+    """
+    root: OutputPathType
+    """Output root folder. This is the root folder for all outputs."""
+
+
+def vectorstats_params(
+    input_: InputPathType,
+    design: InputPathType,
+    contrast: InputPathType,
+    output: str,
+    notest: bool = False,
+    errors: str | None = None,
+    exchange_within: InputPathType | None = None,
+    exchange_whole: InputPathType | None = None,
+    strong: bool = False,
+    nshuffles: int | None = None,
+    permutations: InputPathType | None = None,
+    variance: InputPathType | None = None,
+    ftests: InputPathType | None = None,
+    fonly: bool = False,
+    column: list[VectorstatsColumnParameters] | None = None,
+    info: bool = False,
+    quiet: bool = False,
+    debug: bool = False,
+    force: bool = False,
+    nthreads: int | None = None,
+    config: list[VectorstatsConfigParameters] | None = None,
+    help_: bool = False,
+    version: bool = False,
+) -> VectorstatsParameters:
+    """
+    Build parameters.
+    
+    Args:
+        input_: a text file listing the file names of the input subject data.
+        design: the design matrix.
+        contrast: the contrast matrix.
+        output: the filename prefix for all output.
+        notest: don't perform statistical inference; only output population\
+            statistics (effect size, stdev etc).
+        errors: specify nature of errors for shuffling; options are:\
+            ee,ise,both (default: ee).
+        exchange_within: specify blocks of observations within each of which\
+            data may undergo restricted exchange.
+        exchange_whole: specify blocks of observations that may be exchanged\
+            with one another (for independent and symmetric errors, sign-flipping\
+            will occur block-wise).
+        strong: use strong familywise error control across multiple hypotheses.
+        nshuffles: the number of shuffles (default: 5000).
+        permutations: manually define the permutations (relabelling). The input\
+            should be a text file defining a m x n matrix, where each relabelling\
+            is defined as a column vector of size m, and the number of columns, n,\
+            defines the number of permutations. Can be generated with the\
+            palm_quickperms function in PALM\
+            (http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/PALM). Overrides the -nshuffles\
+            option.
+        variance: define variance groups for the G-statistic; measurements for\
+            which the expected variance is equivalent should contain the same index.
+        ftests: perform F-tests; input text file should contain, for each\
+            F-test, a row containing ones and zeros, where ones indicate the rows\
+            of the contrast matrix to be included in the F-test.
+        fonly: only assess F-tests; do not perform statistical inference on\
+            entries in the contrast matrix.
+        column: add a column to the design matrix corresponding to subject\
+            element-wise values (note that the contrast matrix must include an\
+            additional column for each use of this option); the text file provided\
+            via this option should contain a file name for each subject.
+        info: display information messages.
+        quiet: do not display information messages or progress status;\
+            alternatively, this can be achieved by setting the MRTRIX_QUIET\
+            environment variable to a non-empty string.
+        debug: display debugging messages.
+        force: force overwrite of output files (caution: using the same file as\
+            input and output might cause unexpected behaviour).
+        nthreads: use this number of threads in multi-threaded applications\
+            (set to 0 to disable multi-threading).
+        config: temporarily set the value of an MRtrix config file entry.
+        help_: display this information page and exit.
+        version: display version information and exit.
+    Returns:
+        Parameter dictionary
+    """
+    params = {
+        "__STYXTYPE__": "vectorstats",
+        "notest": notest,
+        "strong": strong,
+        "fonly": fonly,
+        "info": info,
+        "quiet": quiet,
+        "debug": debug,
+        "force": force,
+        "help": help_,
+        "version": version,
+        "input": input_,
+        "design": design,
+        "contrast": contrast,
+        "output": output,
+    }
+    if errors is not None:
+        params["errors"] = errors
+    if exchange_within is not None:
+        params["exchange_within"] = exchange_within
+    if exchange_whole is not None:
+        params["exchange_whole"] = exchange_whole
+    if nshuffles is not None:
+        params["nshuffles"] = nshuffles
+    if permutations is not None:
+        params["permutations"] = permutations
+    if variance is not None:
+        params["variance"] = variance
+    if ftests is not None:
+        params["ftests"] = ftests
+    if column is not None:
+        params["column"] = column
+    if nthreads is not None:
+        params["nthreads"] = nthreads
+    if config is not None:
+        params["config"] = config
+    return params
+
+
+def vectorstats_cargs(
+    params: VectorstatsParameters,
+    execution: Execution,
+) -> list[str]:
+    """
+    Build command-line arguments from parameters.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Command-line arguments.
+    """
+    cargs = []
+    cargs.append("vectorstats")
+    if params.get("notest"):
+        cargs.append("-notest")
+    if params.get("errors") is not None:
+        cargs.extend([
+            "-errors",
+            params.get("errors")
+        ])
+    if params.get("exchange_within") is not None:
+        cargs.extend([
+            "-exchange_within",
+            execution.input_file(params.get("exchange_within"))
+        ])
+    if params.get("exchange_whole") is not None:
+        cargs.extend([
+            "-exchange_whole",
+            execution.input_file(params.get("exchange_whole"))
+        ])
+    if params.get("strong"):
+        cargs.append("-strong")
+    if params.get("nshuffles") is not None:
+        cargs.extend([
+            "-nshuffles",
+            str(params.get("nshuffles"))
+        ])
+    if params.get("permutations") is not None:
+        cargs.extend([
+            "-permutations",
+            execution.input_file(params.get("permutations"))
+        ])
+    if params.get("variance") is not None:
+        cargs.extend([
+            "-variance",
+            execution.input_file(params.get("variance"))
+        ])
+    if params.get("ftests") is not None:
+        cargs.extend([
+            "-ftests",
+            execution.input_file(params.get("ftests"))
+        ])
+    if params.get("fonly"):
+        cargs.append("-fonly")
+    if params.get("column") is not None:
+        cargs.extend([a for c in [dyn_cargs(s["__STYXTYPE__"])(s, execution) for s in params.get("column")] for a in c])
+    if params.get("info"):
+        cargs.append("-info")
+    if params.get("quiet"):
+        cargs.append("-quiet")
+    if params.get("debug"):
+        cargs.append("-debug")
+    if params.get("force"):
+        cargs.append("-force")
+    if params.get("nthreads") is not None:
+        cargs.extend([
+            "-nthreads",
+            str(params.get("nthreads"))
+        ])
+    if params.get("config") is not None:
+        cargs.extend([a for c in [dyn_cargs(s["__STYXTYPE__"])(s, execution) for s in params.get("config")] for a in c])
+    if params.get("help"):
+        cargs.append("-help")
+    if params.get("version"):
+        cargs.append("-version")
+    cargs.append(execution.input_file(params.get("input")))
+    cargs.append(execution.input_file(params.get("design")))
+    cargs.append(execution.input_file(params.get("contrast")))
+    cargs.append(params.get("output"))
+    return cargs
+
+
+def vectorstats_outputs(
+    params: VectorstatsParameters,
+    execution: Execution,
+) -> VectorstatsOutputs:
+    """
+    Build outputs object containing output file paths and possibly stdout/stderr.
+    
+    Args:
+        params: The parameters.
+        execution: The execution object for resolving input paths.
+    Returns:
+        Outputs object.
+    """
+    ret = VectorstatsOutputs(
+        root=execution.output_file("."),
+    )
+    return ret
+
+
+def vectorstats_execute(
+    params: VectorstatsParameters,
+    execution: Execution,
+) -> VectorstatsOutputs:
+    """
+    Statistical testing of vector data using non-parametric permutation testing.
+    
+    This command can be used to perform permutation testing of any form of data.
+    The data for each input subject must be stored in a text file, with one
+    value per row. The data for each row across subjects will be tested
+    independently, i.e. there is no statistical enhancement that occurs between
+    the data; however family-wise error control will be used.
+    
+    In some software packages, a column of ones is automatically added to the
+    GLM design matrix; the purpose of this column is to estimate the "global
+    intercept", which is the predicted value of the observed variable if all
+    explanatory variables were to be zero. However there are rare situations
+    where including such a column would not be appropriate for a particular
+    experimental design. Hence, in MRtrix3 statistical inference commands, it is
+    up to the user to determine whether or not this column of ones should be
+    included in their design matrix, and add it explicitly if necessary. The
+    contrast matrix must also reflect the presence of this additional column.
+    
+    References:
+    
+    .
+    
+    Author: MRTrix3 Developers
+    
+    URL: https://www.mrtrix.org/
+    
+    Args:
+        params: The parameters.
+        execution: The execution object.
+    Returns:
+        NamedTuple of outputs (described in `VectorstatsOutputs`).
+    """
+    params = execution.params(params)
+    cargs = vectorstats_cargs(params, execution)
+    ret = vectorstats_outputs(params, execution)
+    execution.run(cargs)
+    return ret
+
+
+def vectorstats(
+    input_: InputPathType,
+    design: InputPathType,
+    contrast: InputPathType,
+    output: str,
+    notest: bool = False,
+    errors: str | None = None,
+    exchange_within: InputPathType | None = None,
+    exchange_whole: InputPathType | None = None,
+    strong: bool = False,
+    nshuffles: int | None = None,
+    permutations: InputPathType | None = None,
+    variance: InputPathType | None = None,
+    ftests: InputPathType | None = None,
+    fonly: bool = False,
+    column: list[VectorstatsColumnParameters] | None = None,
+    info: bool = False,
+    quiet: bool = False,
+    debug: bool = False,
+    force: bool = False,
+    nthreads: int | None = None,
+    config: list[VectorstatsConfigParameters] | None = None,
+    help_: bool = False,
+    version: bool = False,
+    runner: Runner | None = None,
+) -> VectorstatsOutputs:
+    """
+    Statistical testing of vector data using non-parametric permutation testing.
+    
+    This command can be used to perform permutation testing of any form of data.
+    The data for each input subject must be stored in a text file, with one
+    value per row. The data for each row across subjects will be tested
+    independently, i.e. there is no statistical enhancement that occurs between
+    the data; however family-wise error control will be used.
+    
+    In some software packages, a column of ones is automatically added to the
+    GLM design matrix; the purpose of this column is to estimate the "global
+    intercept", which is the predicted value of the observed variable if all
+    explanatory variables were to be zero. However there are rare situations
+    where including such a column would not be appropriate for a particular
+    experimental design. Hence, in MRtrix3 statistical inference commands, it is
+    up to the user to determine whether or not this column of ones should be
+    included in their design matrix, and add it explicitly if necessary. The
+    contrast matrix must also reflect the presence of this additional column.
+    
+    References:
+    
+    .
+    
+    Author: MRTrix3 Developers
+    
+    URL: https://www.mrtrix.org/
+    
+    Args:
+        input_: a text file listing the file names of the input subject data.
+        design: the design matrix.
+        contrast: the contrast matrix.
+        output: the filename prefix for all output.
+        notest: don't perform statistical inference; only output population\
+            statistics (effect size, stdev etc).
+        errors: specify nature of errors for shuffling; options are:\
+            ee,ise,both (default: ee).
+        exchange_within: specify blocks of observations within each of which\
+            data may undergo restricted exchange.
+        exchange_whole: specify blocks of observations that may be exchanged\
+            with one another (for independent and symmetric errors, sign-flipping\
+            will occur block-wise).
+        strong: use strong familywise error control across multiple hypotheses.
+        nshuffles: the number of shuffles (default: 5000).
+        permutations: manually define the permutations (relabelling). The input\
+            should be a text file defining a m x n matrix, where each relabelling\
+            is defined as a column vector of size m, and the number of columns, n,\
+            defines the number of permutations. Can be generated with the\
+            palm_quickperms function in PALM\
+            (http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/PALM). Overrides the -nshuffles\
+            option.
+        variance: define variance groups for the G-statistic; measurements for\
+            which the expected variance is equivalent should contain the same index.
+        ftests: perform F-tests; input text file should contain, for each\
+            F-test, a row containing ones and zeros, where ones indicate the rows\
+            of the contrast matrix to be included in the F-test.
+        fonly: only assess F-tests; do not perform statistical inference on\
+            entries in the contrast matrix.
+        column: add a column to the design matrix corresponding to subject\
+            element-wise values (note that the contrast matrix must include an\
+            additional column for each use of this option); the text file provided\
+            via this option should contain a file name for each subject.
+        info: display information messages.
+        quiet: do not display information messages or progress status;\
+            alternatively, this can be achieved by setting the MRTRIX_QUIET\
+            environment variable to a non-empty string.
+        debug: display debugging messages.
+        force: force overwrite of output files (caution: using the same file as\
+            input and output might cause unexpected behaviour).
+        nthreads: use this number of threads in multi-threaded applications\
+            (set to 0 to disable multi-threading).
+        config: temporarily set the value of an MRtrix config file entry.
+        help_: display this information page and exit.
+        version: display version information and exit.
+        runner: Command runner.
+    Returns:
+        NamedTuple of outputs (described in `VectorstatsOutputs`).
+    """
+    runner = runner or get_global_runner()
+    execution = runner.start_execution(VECTORSTATS_METADATA)
+    params = vectorstats_params(
+        notest=notest,
+        errors=errors,
+        exchange_within=exchange_within,
+        exchange_whole=exchange_whole,
+        strong=strong,
+        nshuffles=nshuffles,
+        permutations=permutations,
+        variance=variance,
+        ftests=ftests,
+        fonly=fonly,
+        column=column,
+        info=info,
+        quiet=quiet,
+        debug=debug,
+        force=force,
+        nthreads=nthreads,
+        config=config,
+        help_=help_,
+        version=version,
+        input_=input_,
+        design=design,
+        contrast=contrast,
+        output=output,
+    )
+    return vectorstats_execute(params, execution)
+
+
+__all__ = [
+    "VECTORSTATS_METADATA",
+    "VectorstatsColumnParameters",
+    "VectorstatsConfigParameters",
+    "VectorstatsOutputs",
+    "VectorstatsParameters",
+    "vectorstats",
+    "vectorstats_column_params",
+    "vectorstats_config_params",
+    "vectorstats_params",
+]