Skip to content

Run metadata

BasicOutputRunMetaData dataclass

Class for defining variables for the run metadata. Args: tool (str): Name of the tool implementation tool_version (str): Version of the tool implementation config (Path): Path to the config file located in the input directory run_timestamp (int): Time taken for run to complete corpus (Path): Path to corpus used in pheval run mondo_download_date (Optional[str]): ISO timestamp for MONDO file hgnc_download_date (Optional[str]): ISO timestamp for HGNC file tool_specific_configuration_options (Any): Special field that can be overwritten by tool implementations to contain any extra tool specific configurations used in the run

Source code in src/pheval/run_metadata.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@serde
@dataclass
class BasicOutputRunMetaData:
    """Class for defining variables for the run metadata.
    Args:
        tool (str): Name of the tool implementation
        tool_version (str): Version of the tool implementation
        config (Path): Path to the config file located in the input directory
        run_timestamp (int): Time taken for run to complete
        corpus (Path): Path to corpus used in pheval run
        mondo_download_date (Optional[str]): ISO timestamp for MONDO file
        hgnc_download_date (Optional[str]): ISO timestamp for HGNC file
        tool_specific_configuration_options (Any): Special field that can be overwritten by tool implementations to
                                                   contain any extra tool specific configurations used in the run
    """

    tool: str
    tool_version: str
    config: Path
    run_timestamp: int
    corpus: Path
    mondo_download_date: str
    hgnc_download_date: str
    tool_specific_configuration_options: Any = None