Man pages for codecheckers/codecheck
Helper Functions for CODECHECK Project
| add_abstract | Inserts the abstract text and source link into the Markdown... |
| add_all_codecheckers_hyperlink | Add Hyperlinks to Codecheckers Table |
| add_all_venues_hyperlink | Add Hyperlinks to All Venues Table |
| add_cert_links | Function for adding clickable links to the paper for each... |
| add_check_time | Function for adding check time to each report in the register... |
| add_codecheck_details_md | Populates an existing markdown content template with details... |
| add_codechecker | Function for adding codechecker to each report in the... |
| add_issue_number_links | Function for adding clickable links to the issue number of... |
| add_markdown_title | Function to add the markdown title based on the specific... |
| add_paper_details_md | Populates an existing markdown content template with details... |
| add_paper_links | Function for adding clickable links to the paper for each... |
| add_report_links | Function for adding clickable links to the report for each... |
| add_repository_hyperlink | Replaces a placeholder in Markdown content with a hyperlink... |
| add_repository_links_json | Function for adding repository links in the register table... |
| add_venues_hyperlink | Add Hyperlinks to Venues Table |
| add_venue_type_hyperlink | Add Hyperlinks to Venue Type-Specific Table |
| as_latex_url | Wrap URL for LaTeX |
| check_certificate_id | Function for checking ceritificate id if there is a... |
| check_issue_status | Function issue status. If the issue is not closed a warning... |
| cite_certificate | Print a citation for the codecheck certificate. |
| codecheck_metadata | Return the metadata for the codecheck project in root folder... |
| convert_cert_pdf_to_png | Converts each page of a certificate PDF to JPEG format... |
| copy_manifest_files | Copy files from manifest into the codecheck folder and... |
| create_all_codecheckers_table | Create Codecheckers Table |
| create_all_venues_table | Create All Venues Table |
| create_cert_md | Generates a Markdown file for a certificate based on a... |
| create_cert_page_section_files | Generates section files for a certificate HTML page,... |
| create_codecheck_files | Create template files for the codecheck process. |
| create_filtered_reg_csvs | Creates filtered CSV files from a register based on specified... |
| create_index_header_html | Dynamically generates the index_header.html from a template... |
| create_index_postfix_html | Dynamically generates the index_postfix.html from a template... |
| create_index_prefix_html | Dynamically generates the index_prefix.html from a template... |
| create_index_section_files | Creates index postfix, prefix and the header |
| create_md_table | Creates a markdown table from a register template Adds title... |
| create_non_register_files | Create Non-Register Files |
| create_original_register_files | Generates original register files in various output formats. |
| create_register_files | Create Register Files |
| create_tables_non_register | Create Non-Register Tables |
| create_temp_register_with_codechecker | Creates a temporary CSV register with a "Codechecker" column. |
| create_venues_tables | Create Venues Tables |
| create_venue_type_tables | Create Venue Type-Specific Tables |
| download_cert_pdf | Downloads a certificate PDF from a report link and saves it... |
| edit_html_lib_paths | Loads a html file and replaces the libs path in the html file... |
| extract_cert_pdf_from_zip | Downloads a ZIP file from the given URL, searches for... |
| filter_and_drop_register_columns | Filter and Drop Columns from Register Table |
| generate_href | Generate full href for for different href types. |
| generate_html_document_yml | Dynamically generates a html_document.yml with the full paths... |
| generate_html_extra_text_non_register | Generates the extra text of the HTML pages for non registers.... |
| generate_html_postfix_hrefs_non_reg | Generates postfix hrefs for the venues/ codecheckers list... |
| generate_html_postfix_hrefs_reg | Generates the hrefs to set in the postfix.html file for the... |
| generate_html_subtext_non_register | Generates the subtext of the HTML pages for non registers... |
| generate_html_title_non_registers | Generate HTML Title for Non-Register Pages |
| generate_output_dir | Generate Output Directory Path |
| generate_table_details | Generate Table Details |
| generate_table_details_non_reg | Generate Table Details for Non-Register Files |
| get_abstract | Retrieves the abstract of a research paper from CrossRef or... |
| get_abstract_text_crossref | Extracts the paper DOI from the config_yml of the paper,... |
| get_abstract_text_openalex | Retrieves the abstract of a research paper using the OpenAlex... |
| get_cert_link | Retrieves the download link for a certificate file from... |
| get_codecheck_yml | Get the CODECHECK configuration file from a repository |
| get_codecheck_yml_github | Retrieve a codecheck.yml file from a GitHub repository |
| get_codecheck_yml_gitlab | Retrieve a codecheck.yml file from an GitLab.com project |
| get_codecheck_yml_osf | Retrieve a codecheck.yml file from an OSF project |
| get_codecheck_yml_uncached | Retrieve a codecheck.yml file from a remote repository |
| get_or_create_zenodo_record | Create a new Zenodo record and return its pre-assigned DOI |
| get_osf_cert_link | Retrieves the link to a certificate PDF file from an OSF... |
| get_zenodo_cert_link | Accesses a codecheck's Zenodo record via its report link,... |
| get_zenodo_id | Extract the Zenodo record number from the report URL |
| get_zenodo_record | Get the full zenodo record using the record number stored in... |
| latex_codecheck_logo | Print the latex code to include the CODECHECK logo |
| latex_summary_of_manifest | Print a latex table to summarise CODECHECK metadata |
| latex_summary_of_metadata | Print a latex table to summarise CODECHECK metadata |
| list_manifest_files | Summarise manifest files. |
| parse_repository_spec | Parse the repository specification in the column "Repo" in... |
| preprocess_register | Function for preprocessing the register to create and return... |
| register_check | Function for checking all entries in the register |
| register_clear_cache | Function for clearing the register cache |
| register_render | Function for rendering the register into different view |
| render_cert_html | Renders an HTML certificate file from a Markdown template for... |
| render_cert_htmls | Generates HTML files for each certificate listed in the given... |
| render_html | Renders html for a single table |
| render_non_register_md | Render Non-Register Markdown Table |
| render_register | Render Register in Specified Output Format |
| render_register_json | Renders register json for a single register_table |
| render_register_md | Renders register md for a single register_table |
| set_paper_title_references | Set "Title" and "Paper reference" columns and values to the... |
| set_zenodo_certificate | Upload the CODECHECK certificate to Zenodo. |
| upload_zenodo_metadata | Upload metadata to Zenodod |
| validate_codecheck_yml | Validate a CODECHECK configuration |
