Scale

Scale data to unit variance and zero mean

Info

ID: scale
Namespace: transform

Links

Source

Example commands

You can run the pipeline using nextflow run.

View help

You can use --help as a parameter to get an overview of the possible parameters.

nextflow run openpipelines-bio/openpipeline \
  -r 2.1.1 -latest \
  -main-script target/nextflow/transform/scale/main.nf \
  --help

Run command

Example of params.yaml

# Arguments
input: # please fill in - example: "input.h5mu"
modality: "rna"
# input_layer: "foo"
# output_layer: "foo"
# max_value: 123.0
zero_center: true
# output: "output.h5mu"
# output_compression: "gzip"

# Nextflow input-output arguments
publish_dir: # please fill in - example: "output/"
# param_list: "my_params.yaml"

nextflow run openpipelines-bio/openpipeline \
  -r 2.1.1 -latest \
  -profile docker \
  -main-script target/nextflow/transform/scale/main.nf \
  -params-file params.yaml

Note

Replace -profile docker with -profile podman or -profile singularity depending on the desired backend.

Argument group

Arguments

Name	Description	Attributes
--input	Input h5mu file.	file, required, example: "input.h5mu"
--modality	List of modalities to process.	string, default: "rna"
--input_layer	Input layer with data to scale. Uses .X by default	string
--output_layer	Output layer where scaled data will be stored. If not specified, .X will be used.	string
--max_value	Clip (truncate) to this value after scaling. Does not clip by default.	double
--zero_center	If set, omit zero-centering variables, which allows to handle sparse input efficiently.	boolean_false
--output	Output h5mu file.	file, required, default: "output.h5mu"
--output_compression	The compression format to be used on the output h5mu object.	string, example: "gzip"

Authors

• Dries Schaumont (maintainer)