Wait for Simulation results (dataset) to be ready. — waitSimsResults • carboseqsiwaa

Loop waiting for a dataset to be ready : refresh data information, with a 'delay' between 2 requests. Stop as soon as 'end' is TRUE or at the end of 'duration_max'.

waitSimsResults(
  env,
  data_info,
  delay,
  duration_max,
  v,
  with_job_report = FALSE
)

Arguments

env: Siwaa environment
data_info: Input data information
delay: Delay (dataset survey). Unit : second.
duration_max: Duration max (dataset survey). Unit : second.
v: Boolean to choose 'verbose' or 'silent' mode
with_job_report: Boolean to ask or not for job reports.

Value

end Boolean

data_ready Boolean

data_info refreshed data information

output_data_reports Output data reports, always returned (dataset_provenance).

job_reports Some job reports in case of with_job_report (job_info, job_metrics, job_common_problems, job_resume).

message

Details

It is possible to set the survey step between 2 requests ('delay') and the survey total duration ('duration_max').

Possible returned situations at the end of survey :

'end' TRUE, 'data_ready' TRUE : End of process and data ready to be downloaded.
'end' TRUE, 'data_ready' FALSE : End of process but data not ready (will never be ready)
'end' FALSE, 'data_ready' FALSE : Process still running (not finished). In that case you can call 'waitSimsResults' again to continue survey.