idmtools_models.r.json_r_task module#

idmtools jsonr task.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

class idmtools_models.r.json_r_task.JSONConfiguredRTask(command: str | ~idmtools.entities.command_line.CommandLine = <property object>, platform_requirements: ~typing.Set[~idmtools.entities.platform_requirements.PlatformRequirements] = <factory>, _ITask__pre_creation_hooks: ~typing.List[~typing.Callable[[Simulation | IWorkflowItem, IPlatform], ~typing.NoReturn]] = <factory>, _ITask__post_creation_hooks: ~typing.List[~typing.Callable[[Simulation | IWorkflowItem, IPlatform], ~typing.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: str | None = None, Dockerfile: str | None = None, pull_before_build: bool = True, use_nvidia_run: bool = False, _DockerTask__image_built: bool = False, script_path: str = None, r_path: str = 'Rscript', parameters: dict = <factory>, envelope: str = None, config_file_name: str = 'config.json', is_config_common: bool = False, configfile_argument: str | None = '--config', command_line_argument_no_filename: bool = False)[source]#

Bases: JSONConfiguredTask, RTask

JSONConfiguredRTask combines JSONConfiguredTask and RTask.

Notes

  • TODO Add example references here

See also

idmtools_models.json_configured_task.JSONConfiguredTask idmtools_models.r.r_task.RTask

configfile_argument: str | None = '--config'#
gather_common_assets()[source]#

Return the common assets for a JSON Configured Task.

Returns:

Assets

gather_transient_assets() → AssetCollection[source]#

Get Transient assets. This should general be the config.json.

Returns:

Transient assets

reload_from_simulation(simulation: Simulation, **kwargs)[source]#

Reload task details from a simulation. Used in some fetch operations.

Parameters:

  • simulation – Simulation that is parent item

  • **kwargs –

Returns:

None

pre_creation(parent: Simulation | IWorkflowItem, platform: IPlatform)[source]#

Pre-creation event.

Proxy calls to JSONConfiguredTask and RTask

Parameters:

  • parent – Parent item

  • platform – Platform item is being created on

Returns:

None

post_creation(parent: Simulation | IWorkflowItem, platform: IPlatform)[source]#

Post-creation of task.

Proxy calls to JSONConfiguredTask and RTask

Parameters:

  • parent – Parent item

  • platform – Platform we are executing on

Returns:

None

__init__(command: str | ~idmtools.entities.command_line.CommandLine = <property object>, platform_requirements: ~typing.Set[~idmtools.entities.platform_requirements.PlatformRequirements] = <factory>, _ITask__pre_creation_hooks: ~typing.List[~typing.Callable[[Simulation | IWorkflowItem, IPlatform], ~typing.NoReturn]] = <factory>, _ITask__post_creation_hooks: ~typing.List[~typing.Callable[[Simulation | IWorkflowItem, IPlatform], ~typing.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: str | None = None, Dockerfile: str | None = None, pull_before_build: bool = True, use_nvidia_run: bool = False, _DockerTask__image_built: bool = False, script_path: str = None, r_path: str = 'Rscript', parameters: dict = <factory>, envelope: str = None, config_file_name: str = 'config.json', is_config_common: bool = False, configfile_argument: str | None = '--config', command_line_argument_no_filename: bool = False) → None#
class idmtools_models.r.json_r_task.JSONConfiguredRTaskSpecification[source]#

Bases: TaskSpecification

JSONConfiguredRTaskSpecification provides the plugin info for JSONConfiguredRTask.

get(configuration: dict) → JSONConfiguredRTask[source]#

Get instance of JSONConfiguredRTaskSpecification with configuration provided.

Parameters:

configuration – Configuration for object

Returns:

JSONConfiguredRTaskSpecification with configuration

get_description() → str[source]#

Get description of plugin.

Returns:

Description of plugin

get_example_urls() → List[str][source]#

Get Examples for JSONConfiguredRTask.

Returns:

List of Urls that point to examples for JSONConfiguredRTask

get_type() → Type[JSONConfiguredRTask][source]#

Get Type for Plugin.

Returns:

JSONConfiguredRTask

get_version() → str[source]#

Returns the version of the plugin.

Returns:

Plugin Version