Skip to contents
add_abstract()
Inserts the abstract text and source link into the Markdown content if an abstract is found for the given repository. If no abstract is found, an empty string is inserted in place of the abstract content.
add_all_codecheckers_hyperlink()
Add Hyperlinks to Codecheckers Table
add_all_venues_hyperlinks_non_reg()
Add Hyperlinks to All Venues Table
add_cert_links()
Function for adding clickable links to the paper for each entry in the register table and add certificate identifier and link as extra columns
add_check_time()
Function for adding check time to each report in the register table.
add_codecheck_details_md()
Populates an existing markdown content template with details about the CODECHECK details.
add_codechecker()
Function for adding codechecker to each report in the register table.
add_issue_number_links()
Function for adding clickable links to the issue number of each report in the register table.
add_markdown_title()
Function to add the markdown title based on the specific register table name.
add_paper_details_md()
Populates an existing markdown content template with details about the codechecked paper.
add_paper_links()
Function for adding clickable links to the paper for each entry in the register table.
add_report_links()
Function for adding clickable links to the report for each entry in the register table.
add_repository_hyperlink()
Replaces a placeholder in Markdown content with a hyperlink to the repository, based on the repository type (e.g., GitHub, OSF, GitLab).
add_repository_links_json()
Function for adding repository links in the register table for the creation of the json file.
add_venue_hyperlinks_reg()
Function for adding clickable links to the codecheck venue pages for each entry in the register table.
add_venue_type_hyperlinks_non_reg()
Add Hyperlinks to Venue Type-Specific Table
add_venue_type_hyperlinks_reg()
Function for adding clickable links to the codecheck venue type pages for each entry in the register table.
add_venues_hyperlinks_non_reg()
Add Hyperlinks to Venues Table
as_latex_url()
Wrap URL for LaTeX
check_certificate_id()
Function for checking ceritificate id if there is a codecheck_yaml. If there is a mismatch a stop is sent. Else a warning is thrown.
check_issue_status()
Function issue status. If the issue is not closed a warning is thrown stating that the issue is still open.
cite_certificate()
Print a citation for the codecheck certificate.
codecheck_metadata()
Return the metadata for the codecheck project in root folder of project
complete_codecheck_yml()
Analyze and complete codecheck.yml with missing fields
convert_cert_pdf_to_png()
Converts each page of a certificate PDF to JPEG format images, saving them in the specified certificate directory.
copy_manifest_files()
Copy files from manifest into the codecheck folder and summarise.
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 specified template, filling in details about the paper, authors, codecheck information, and the certificate images if available. The resulting Markdown file is later rendered to HTML.
create_cert_page_section_files()
Generates section files for a certificate HTML page, including prefix, postfix, and header HTML components.
create_codecheck_files()
Create template files for the codecheck process.
create_filtered_reg_csvs()
Creates filtered CSV files from a register based on specified filters.
create_index_header_html()
Dynamically generates the index_header.html from a template file
create_index_postfix_html()
Dynamically generates the index_postfix.html from a template file
create_index_prefix_html()
Dynamically generates the index_prefix.html from a template file
create_index_section_files()
Creates index postfix, prefix and the header
create_md_table()
Creates a markdown table from a register template Adds title to the markdown and adjusts the column widths of the table before returning it.
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_venue_type_tables()
Create Venue Type-Specific Tables
create_venues_tables()
Create Venues Tables
download_cert_pdf()
Downloads a certificate PDF from a report link and saves it locally. If the download link is a ZIP file, it extracts the PDF from the archive. Returns status based on success.
edit_html_lib_paths()
Loads a html file and replaces the libs path in the html file to the libs folder in "docs/libs" This is done so all html files can share one libs folder.
extract_cert_pdf_from_zip()
Downloads a ZIP file from the given URL, searches for "codecheck.pdf" within its contents, renames it to "cert.pdf," and saves it in the specified directory.
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 to the index header, prefix and postfix.html files.
generate_html_extra_text_non_register()
Generates the extra text of the HTML pages for non registers. This extra text is to be placed under the table. There is only extra text for the codecheckers HTML page to explain the reason for discrepancy between total_codechecks != SUM(no.of codechecks)
generate_html_postfix_hrefs_non_reg()
Generates postfix hrefs for the venues/ codecheckers list pages
generate_html_postfix_hrefs_reg()
Generates the hrefs to set in the postfix.html file for the rendering of register tables.
generate_html_subtext_non_register()
Generates the subtext of the HTML pages for non registers with a summary of the number of codechecks and number of codechecks/ venues etc.
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 OpenAlex.
get_abstract_text_crossref()
Extracts the paper DOI from the config_yml of the paper, constructs a CrossRef API request, and returns the abstract text if available.
get_abstract_text_openalex()
Retrieves the abstract of a research paper using the OpenAlex API.
get_cert_link()
Retrieves the download link for a certificate file from Zenodo, OSF, or ResearchEquals.
get_certificate_from_github_issue()
Get certificate identifier from GitHub issues by matching author names
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_codecheck_yml_zenodo()
Retrieve a codecheck.yml file from a Zenodo record
get_lifecycle_metadata()
Retrieve metadata from Lifecycle Journal
get_or_create_zenodo_record()
Create or retrieve Zenodo record, submit to CODECHECK community, and update codecheck.yml
get_osf_cert_link()
Retrieves the link to a certificate PDF file from an OSF project node. It retrieves its files, and searches for a single PDF certificate file within the node. If multiple or no PDF files are found, it returns NULL with a warning.
get_researchequals_cert_link()
Accesses a codecheck's ResearchEquals record via its report link and download the main file of the module
get_zenodo_cert_link()
Accesses a codecheck's Zenodo record via its report link, retrieves the record ID, and searches for a certificate PDF or ZIP file within the record's files using the Zenodo API.
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 the metadata.
is_placeholder_certificate()
Check if certificate identifier or DOI is a placeholder
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 the register CSV file
preprocess_register()
Function for preprocessing the register to create and return the preprocessed register table.
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 a specific certificate.
render_cert_htmls()
Generates HTML files for each certificate listed in the given register table. It checks for the existence of the certificate PDF, downloads it if necessary, and converts it to JPEG format for embedding.
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 register_table
update_certificate_from_github()
Update certificate ID from GitHub issue
update_codecheck_yml_from_lifecycle()
Update codecheck.yml with Lifecycle Journal metadata
upload_zenodo_certificate() set_zenodo_certificate()
Upload the CODECHECK certificate and additional files to Zenodo.
upload_zenodo_metadata()
Upload metadata to Zenodo
validate_certificate_for_rendering()
Validate certificate for rendering with visual warning
validate_codecheck_yml()
Validate a CODECHECK configuration
validate_codecheck_yml_crossref()
Validate codecheck.yml metadata against CrossRef
validate_codecheck_yml_orcid()
Validate codecheck.yml metadata against ORCID
validate_contents_references()
Validate codecheck.yml metadata against external references
validate_yaml_syntax()
Validate YAML syntax of a codecheck.yml file