scDesign3Py.get_bpparam

scDesign3Py.get_bpparam(mode=typing.Literal['MulticoreParam', 'SnowParam'], show=True, **kwargs)[source]

Get your parallelization parameters robject

Check R function BiocParallel::MulticoreParam and BiocParallel::SnowParam for more informarion on how to set the parameters.

Details:

For users who are going to use ‘bpmapply’ as the parallel method, this function provide the interface to create the control param. The implemented mode including ‘MulticoreParam’ for linux/Mac users and ‘SnowParam’ for windows users.

Arguments:

mode: str: The type of your selected parallel parameter. If windows, choose SnowParam. If linux or mac, choose MulticoreParam or SnowParam.
show: bool (default: True): Whether to print the constructed onject information on the screen.

Output:

rpy2.robjects.methods.RS4

A R class specifying the parrallel parameters.

Combined use with @parallelization = bpmapply.