Upload

get_component(args, name, component_type, text)

Generate an upload field and its functionality for a given component of the evaluations.

Parameters:

Name	Type	Description	Default
name	str	The name of the component as it should be recorded in the session state and as it exists in the args.	required
component_type	Any	The type of the component (to ensure that only the expected object can be uploaded)	required
text	str	The human-readable text to display to the user as part of the element.	required

Source code in src/nhssynth/modules/dashboard/Upload.py

def get_component(args: argparse.Namespace, name: str, component_type: Any, text: str) -> None:
    """
    Generate an upload field and its functionality for a given component of the evaluations.

    Args:
        name: The name of the component as it should be recorded in the session state and as it exists in the args.
        component_type: The type of the component (to ensure that only the expected object can be uploaded)
        text: The human-readable text to display to the user as part of the element.
    """
    uploaded = st.file_uploader(f"Upload a pickle file containing a {text}", type="pkl")
    if getattr(args, name):
        with open(os.getcwd() + "/" + getattr(args, name), "rb") as f:
            loaded = pickle.load(f)
    if uploaded is not None:
        loaded = pickle.load(uploaded)
    if loaded is not None:
        assert isinstance(loaded, component_type), f"Uploaded file does not contain a {text}!"
        st.session_state[name] = loaded.contents
        st.success(f"Loaded {text}!")

parse_args()

These arguments allow a user to automatically load the required data for the dashboard from disk.

Returns:

Type	Description
Namespace	The parsed arguments.

Source code in src/nhssynth/modules/dashboard/Upload.py

def parse_args() -> argparse.Namespace:
    """
    These arguments allow a user to automatically load the required data for the dashboard from disk.

    Returns:
        The parsed arguments.
    """
    parser = argparse.ArgumentParser(description="NHSSynth Evaluation Dashboard")
    parser.add_argument("--evaluations", type=str, help="Path to a set of evaluations.")
    parser.add_argument("--experiments", type=str, help="Path to a set of experiments.")
    parser.add_argument("--synthetic-datasets", type=str, help="Path to a set of synthetic datasets.")
    parser.add_argument("--typed", type=str, help="Path to a typed real dataset.")
    return parser.parse_args()