idmtools_models.r.r_task module

class idmtools_models.r.r_task.RTask(command: Union[str, idmtools.entities.command_line.CommandLine] = <property object at 0x7f7634030b30>, platform_requirements: Set[idmtools.entities.platform_requirements.PlatformRequirements] = <factory>, _ITask__pre_creation_hooks: List[Callable[[Union[ForwardRef('Simulation'), ForwardRef('IWorkflowItem')], ForwardRef('IPlatform')], NoReturn]] = <factory>, _ITask__post_creation_hooks: List[Callable[[Union[ForwardRef('Simulation'), ForwardRef('IWorkflowItem')], ForwardRef('IPlatform')], NoReturn]] = <factory>, common_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, transient_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, image_name: str = None, build: bool = False, build_path: Union[str, NoneType] = None, Dockerfile: Union[str, NoneType] = None, pull_before_build: bool = True, use_nvidia_run: bool = False, _DockerTask__image_built: bool = False, script_path: str = None, r_path: str = 'Rscript')

Bases: idmtools.core.docker_task.DockerTask

script_path: str = None

r_path: str = 'Rscript'

reload_from_simulation(simulation: idmtools.entities.simulation.Simulation, **kwargs)

Optional hook that is called when loading simulations from a platform

gather_common_assets() → idmtools.assets.asset_collection.AssetCollection

Gather R Assets Returns:

gather_transient_assets() → idmtools.assets.asset_collection.AssetCollection

Gather transient assets. Generally this is the simulation level assets

Returns:

pre_creation(parent: Union[idmtools.entities.simulation.Simulation, idmtools.entities.iworkflow_item.IWorkflowItem], platform: IPlatform)

Called before creation of parent

Parameters

• parent – Parent

• platform – Platform R Task is executing on

Returns

None

Raise:

ValueError if script name is not provided

class idmtools_models.r.r_task.RTaskSpecification

Bases: idmtools.registry.task_specification.TaskSpecification

get(configuration: dict) → idmtools_models.r.r_task.RTask

Get instance of RTask

Parameters

configuration – configuration for task

Returns

RTask with configuration

get_description() → str

Returns the Description of the plugin

Returns

Plugin Description

get_type() → Type[idmtools_models.r.r_task.RTask]

Get Type for Plugin

Returns

RTask

get_version() → str

Returns the version of the plugin

Returns

Plugin Version