Options for model_gene_variances() and friends.
More...
#include <model_gene_variances.hpp>
Public Attributes | |
| FitVarianceTrendOptions | fit_variance_trend_options |
| scran_blocks::WeightPolicy | block_weight_policy = scran_blocks::WeightPolicy::VARIABLE |
| scran_blocks::VariableWeightParameters | variable_block_weight_parameters |
| bool | compute_average = true |
| int | num_threads = 1 |
Detailed Description
Options for model_gene_variances() and friends.
Member Data Documentation
◆ fit_variance_trend_options
| FitVarianceTrendOptions scran_variances::ModelGeneVariancesOptions::fit_variance_trend_options |
Options for fitting the mean-variance trend.
◆ block_weight_policy
| scran_blocks::WeightPolicy scran_variances::ModelGeneVariancesOptions::block_weight_policy = scran_blocks::WeightPolicy::VARIABLE |
Policy to use for weighting the contribution from each block when computing the average for each statistic. Only relevant to model_gene_variances_blocked() overloads where averaged outputs are requested.
◆ variable_block_weight_parameters
| scran_blocks::VariableWeightParameters scran_variances::ModelGeneVariancesOptions::variable_block_weight_parameters |
Parameters for the variable block weights. Only relevant to model_gene_variances_blocked() overloads where averaged outputs are requested and ModelGeneVariancesOptions::block_weight_policy = scran_blocks::WeightPolicy::VARIABLE.
◆ compute_average
Whether to compute the average of each statistic across blocks. Note that this only affects the model_gene_variances_blocked() method that returns a ModelGeneVariancesBlockedResults object.
◆ num_threads
| int scran_variances::ModelGeneVariancesOptions::num_threads = 1 |
Number of threads to use. The parallelization scheme is defined by tatami::parallelize() and FitVarianceTrendOptions::num_threads.
The documentation for this struct was generated from the following file:
- scran_variances/model_gene_variances.hpp
