{"id":14067252,"url":"https://github.com/insightsengineering/thevalidatoR","last_synced_at":"2025-07-30T00:33:03.216Z","repository":{"id":41812791,"uuid":"398193453","full_name":"insightsengineering/thevalidatoR","owner":"insightsengineering","description":"Github Action that generates R Package Validation documentation 🏁","archived":false,"fork":false,"pushed_at":"2025-04-09T08:41:03.000Z","size":676,"stargazers_count":62,"open_issues_count":5,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-07-09T09:07:49.492Z","etag":null,"topics":["github-actions","r","r-package-automation","validation"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/r-package-validation-report","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/insightsengineering.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":["https://pharmaverse.org"]}},"created_at":"2021-08-20T07:31:19.000Z","updated_at":"2025-03-22T08:13:04.000Z","dependencies_parsed_at":"2023-01-11T17:22:08.419Z","dependency_job_id":"d283eedd-c0a5-4c28-91ff-36c2d888266f","html_url":"https://github.com/insightsengineering/thevalidatoR","commit_stats":{"total_commits":57,"total_committers":8,"mean_commits":7.125,"dds":"0.45614035087719296","last_synced_commit":"5bbfaa530233bbea4d4d3a4f454202a09ebf630e"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/insightsengineering/thevalidatoR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2FthevalidatoR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2FthevalidatoR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2FthevalidatoR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2FthevalidatoR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/insightsengineering","download_url":"https://codeload.github.com/insightsengineering/thevalidatoR/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2FthevalidatoR/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267785798,"owners_count":24144122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","r","r-package-automation","validation"],"created_at":"2024-08-13T07:05:30.353Z","updated_at":"2025-07-30T00:33:02.863Z","avatar_url":"https://github.com/insightsengineering.png","language":"R","funding_links":["https://pharmaverse.org"],"categories":["Ranked by starred repositories","R","Regulatory \u0026 Submission Tools"],"sub_categories":["Validation Tools for Software Compliance"],"readme":"# thevalidatoR\n\n \u003cimg src='https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/PNG/thevalidatoR.png' align=\"right\" height=\"131.5\" /\u003e\n\n[\u003cimg src=\"http://pharmaverse.org/shields/thevalidatoR.png\"\u003e](https://pharmaverse.org)\n[![SuperLinter](https://github.com/insightsengineering/thevalidatoR/actions/workflows/lint.yaml/badge.svg)](https://github.com/insightsengineering/thevalidatoR/actions/workflows/lint.yaml)\n[![Test This Action](https://github.com/insightsengineering/thevalidatoR/actions/workflows/test.yaml/badge.svg)](https://github.com/insightsengineering/thevalidatoR/actions/workflows/test.yaml)\n\n- [thevalidatoR](#thevalidator)\n- [An R Package Validation Report](#an-r-package-validation-report)\n    - [Description](#description)\n    - [Action Type](#action-type)\n    - [Author](#author)\n    - [Inputs](#inputs)\n    - [Outputs](#outputs)\n  - [How to use](#how-to-use)\n    - [Quickstart](#quickstart)\n    - [V1.0 Examples](#v10-examples)\n      - [rbmi](#rbmi)\n      - [admiral](#admiral)\n\n\u003c!-- BEGIN_ACTION_DOC --\u003e\n# R Package Validation Report\n\n### Description\nA Github Action that generates a validation report for an R package.\nThe four main steps are:\n- Run `R CMD check` (check installation)\n- Run `covr::package_coverage()` (check unit test coverage)\n- Run `covtracer` (link documentation to unit tests)\n- Place results into report\n- Attach report as object to release\n\n### Action Type\nComposite\n\n### Author\nRoche\n\n### Inputs\n* `report_pkg_dir`:\n\n  _Description_: Path to package's root.\n\n  _Required_: `false`\n\n  _Default_: `.`\n\n* `report_template_path`:\n\n  _Description_: File path of the R markdown template to use for the report.\nThe default template is available [here.](./template.qmd)\n\n\n  _Required_: `false`\n\n  _Default_: `./template.qmd`\n\n* `no_cache`:\n\n  _Description_: Disable github action R dependency caching\n\n  _Required_: `false`\n\n  _Default_: `false`\n\n* `cache_version`:\n\n  _Description_: Version of the cache. To clean cache bump this version.\n\n  _Required_: `false`\n\n  _Default_: `v1`\n\n* `disable_install_dev_deps`:\n\n  _Description_: Disable installation of dev dependencies while\nbuilding the report.\n\n\n  _Required_: `false`\n\n  _Default_: `false`\n\n### Outputs\nNone\n\u003c!-- END_ACTION_DOC --\u003e\n\n## How to use\n\nTo use this GitHub Action you will need to complete the following:\n\n- Create a new file in your repository called `.github/workflows/r-pkg-validation.yml`\n- Copy the template over (and edit if you wish to modify it)\n\n### Quickstart\n\nIn your repository you should have a `.github/workflows/validatoR.yml` file with GitHub Action similar to below:\n\n```yaml\n---\nname: R Package Validation report\n\non: # Run this action when a release is published\n  release:\n    types: [published]\n\njobs:\n  r-pkg-validation:\n    name: Create report 📃\n    runs-on: ubuntu-latest\n    container:\n      image: rocker/verse:4.4.1\n    # Set Github token permissions\n    env:\n      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}\n    permissions:\n      contents: write\n      packages: write\n      deployments: write\n    steps:\n      - name: Checkout repo 🛎\n        uses: actions/checkout@v4\n\n      - name: Build report 🏗\n        id: validation\n        uses: insightsengineering/thevalidatoR@v2\n        # see parameters above for custom templates and other formats\n\n      # Upload the validation report to the release\n      - name: Upload report to release 🔼\n        if: success()\n        uses: svenstaro/upload-release-action@v2\n        with:\n          file: ./validation_report.pdf\n          asset_name: validation-report.pdf\n          repo_token: ${{ secrets.GITHUB_TOKEN }}\n          tag: ${{ github.ref }}\n          overwrite: true\n```\n\n### V1.0 Examples\n\n#### rbmi\n\nYou can see an example report from [rbmi](https://github.com/insightsengineering/rbmi), using the first version of this gh-action, [here](readme_files/report-1.0.1-rbmi.pdf).\n\nThis was built as a test on a fork of the original rbmi package. When we created a release in that fork, this PDF was automatically built and added to the release as can be seen below.\n\n![](readme_files/rbmi_action.png)\n\nAnd you can see the gh-action action that was triggered by the release being published. Note that it must install the package, run tests and\nconstruct the metrics needed by cov-tracer and covr, which in the case of `rbmi` a computationally heavy package - took quite a while!\n\n![](readme_files/rbmi_release.png)\n\n#### admiral\n\nYou can see an example report from [admiral](https://github.com/Roche-GSK/admiral), using the first version of this gh-action, [here](readme_files/report-0.1-admiral.pdf).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsengineering%2FthevalidatoR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsightsengineering%2FthevalidatoR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsengineering%2FthevalidatoR/lists"}