wrappers/preprocessing/regress_out
Description
Regress out (mostly) unwanted sources of variation, running either the GPU
(rapids-singlecell) or the CPU (scanpy) variant of regress_out,
selected with --device_type.
Inputs
Name | Type & Properties | Description |
|---|---|---|
--input | file required | Input h5mu file. |
--modality | string | Which modality from the input MuData file to process. |
--input_layer | string | Input layer to use. By default, X is used. |
--obs_keys | string required multiple | Keys of the .obs columns to regress out as covariates. |
Compute
Name | Type & Properties | Description |
|---|---|---|
--device_type | string | Which implementation to run: the GPU (rapids-singlecell) variant or the CPU (scanpy/squidpy) variant of the component. Selecting `gpu` requires a CUDA-capable GPU; the component errors out if none is available (there is no automatic fallback to CPU). |
Outputs
Name | Type & Properties | Description |
|---|---|---|
--output | file required output | Output h5mu file. |
--output_layer | string | Output layer to use. By default, use X. |
--output_compression | string | Compression format to use for the output AnnData and/or Mudata objects. By default no compression is applied. |
rapids-singlecell options
Name | Type & Properties | Description |
|---|---|---|
--batchsize | integer | Number of genes per batch. If None, all genes are processed at once. |
Run this component
Run the following command to execute this component with Nextflow:
cat > params.yaml <<'EOM'
modality: [ "rna" ]
device_type: [ "gpu" ]
output: "$id.$key.output.h5mu"
id: "run"
publish_dir: "output/"
EOM
nextflow run https://packages.viash-hub.com/vsh/openpipeline_rapids.git \
-revision v0.1.3 \
-main-script target/nextflow/wrappers/preprocessing/regress_out/main.nf \
-params-file params.yaml Relationships
Used by
0 relationships
No components use this component.
Current component
wrappers/preprocessing/regress_outopenpipeline_rapids v0.1.3