webinterface.pages.base_pages.tab5_public_submission module#

webinterface.pages.base_pages.tab5_public_submission.clear_highlight_column(all_datapoints_submission: str) → None[source]#

Remove the highlight column from the submission data if it exists.

webinterface.pages.base_pages.tab5_public_submission.compare_dictionaries(old_dict, new_dict)[source]#

Generate a human-readable string describing differences between two dictionaries.

Parameters:

  • old_dict (dict) – The old dictionary.

  • new_dict (dict) – The new dictionary.

Returns:

The human-readable string describing the differences between the two dictionaries.

Return type:

str

webinterface.pages.base_pages.tab5_public_submission.copy_dataframes_for_submission(variables) → None[source]#

Create copies of the dataframes before submission.

webinterface.pages.base_pages.tab5_public_submission.create_pull_request(variables, ionmodule, user_input, params_from_file: dict[str, Any], params: dataclass) → str | None[source]#

Submit the pull request with the benchmark results and returns the PR URL.

Parameters:

params (Any) – The parameters object.

Returns:

The URL of the pull request.

Return type:

Optional[str]

webinterface.pages.base_pages.tab5_public_submission.generate_additional_parameters_fields_submission(variables, user_input) → None[source]#

Create the additional parameters section of the form and initializes the parameter fields.

webinterface.pages.base_pages.tab5_public_submission.generate_comments_section(variables, user_input) → None[source]#

Create the text area for submission comments.

webinterface.pages.base_pages.tab5_public_submission.generate_confirmation_checkbox(check_submission: str) → None[source]#

Create the confirmation checkbox for metadata correctness.

webinterface.pages.base_pages.tab5_public_submission.generate_metadata_uploader(variables, user_input) → None[source]#

Create the file uploader for meta data.

webinterface.pages.base_pages.tab5_public_submission.generate_submission_button(button_submission_uuid) → str | None[source]#

Create a button for public submission and returns the PR URL if the button is pressed.

Returns:

The URL of the pull request.

Return type:

Optional[str]

webinterface.pages.base_pages.tab5_public_submission.generate_submission_ui_elements(variables, user_input) → bool[source]#

Create the UI elements necessary for data submission, including metadata uploader and comments section.

webinterface.pages.base_pages.tab5_public_submission.get_form_values(variables) → dict[str, Any][source]#

Retrieve all user inputs from Streamlit session state and returns them as a dictionary.

Returns:

A dictionary containing all user inputs.

Return type:

dict[str, Any]

webinterface.pages.base_pages.tab5_public_submission.load_user_parameters(variables, ionmodule, user_input) → Any[source]#

Read and process the parameter files provided by the user.

Returns:

The parsed parameters.

Return type:

Any

webinterface.pages.base_pages.tab5_public_submission.save_intermediate_submission_data(variables, ionmodule, user_input) → None[source]#

Store intermediate and input data to the storage directory if available.

webinterface.pages.base_pages.tab5_public_submission.show_submission_success_message(variables, pr_url) → None[source]#

Handle the UI updates and notifications after a successful submission.

Parameters:

pr_url (str) – The URL of the pull request.

webinterface.pages.base_pages.tab5_public_submission.submit_to_repository(variables, ionmodule, user_input, params_from_file, params) → str | None[source]#

Handle the submission process of the benchmark results to the ProteoBench repository.

Parameters:

params (ProteoBenchParameters) – The parameters for the submission.

Returns:

The URL of the pull request if the submission was successful.

Return type:

str, optional