calour.transforming.transform

calour.transforming.transform(exp: calour.experiment.Experiment, steps=[], inplace=False, **kwargs)[source]

Chain transformations together.

Note

This function is also available as a class method Experiment.transform()

Note

This function is also available as a class method Experiment.transform()

Parameters:
  • exp (Experiment) – Input experiment object.
  • exp – Input experiment object.
  • steps (list of callable) – each callable is a transformer that takes Experiment object as its 1st argument and has a boolean parameter of inplace. Each callable should return an Experiment object.
  • inplace (bool) – transformation occuring in the original data or a copy
  • kwargs (dict) – keyword arguments to pass to each transformers. The key should be in the form of “<transformer_name>__<param_name>”. For example, “transform(exp: Experiment, steps=[log_n], log_n__n=3)” will set “n” of function “log_n” to 3
Returns:

with its data transformed

Return type:

Experiment