avid.common.artefact.generator.generate_artefact_entry

avid.common.artefact.generator.generate_artefact_entry(case, time_point, action_tag, artefact_type='result', case_instance=None, url=None, objective=None, invalid=False, **additional_props)

This is a generic method to generate an arbitrary artefact entry. dict (**kwargs) can be used to pass additional infos for the dict entry

Parameters:

• case – Case ID for the artefact (e.g. Patient ID). May be set to None to indicate that it is a general artefact (not case specific).

• case_instance – ID of a case instance. May be set to None to indicate that the artefact has/is no variation

• time_point – Timepoint the artefact is correlated with. Should be an ordinal type (e.g. int or str)

• action_tag – Tag of the action that generates/generated the artefact.

• artefact_type – Type of the artefact (e.g. “result”, “config”, “misc”)

• url – Location where the artefact is stored

• objective – the objective of the artefact (may be set to None)

• invalid – Indicates if the artefact is valid (e.g. correctly stored)

• additional_props – additional properties you want to add to the artefact entry