{"Package":"test.assessr","Title":"Assessing Package Test Reliability and Quality","Version":"1.1.1","Authors@R":"c(\nperson(\"Edward\", \"Gillian\", , \"edward.gillian-ext@sanofi.com\", role = c(\"cre\", \"aut\"), comment = c(ORCID = \"0000-0003-2732-5107\")),\nperson(\"Hugo\", \"Bottois\", , \"hugo.bottois@sanofi.com\", role = \"aut\", comment = c(ORCID = \"0000-0003-4674-0875\")),\nperson(\"Paulin\", \"Charliquart\", , \"paulin.charliquart@sanofi.com\", role = \"aut\"),\nperson(\"Andre\", \"Couturier\", , \"andre.couturier@sanofi.com\", role = \"aut\"),\nperson(\"Sanofi\", role = c(\"cph\", \"fnd\")))","Description":"A reliable and validated tool that calculates unit test coverage for R packages with standard testing frameworks and non-standard testing frameworks.","License":"GPL (>= 2)","BugReports":"https://github.com/Sanofi-Public/test.assessr/issues","Depends":"R (>= 4.1.0)","Imports":"callr, checkmate, covr, dplyr, fs, jsonlite, pkgload, remotes,\nrlang, rmarkdown, RUnit, stringr, testthat (>= 3.0.0), tidyr,\nutils, withr","Suggests":"devtools, DT, here, kableExtra, knitr, methods, R6, S7,\nroxygen2, tidyselect, tools, mockery","Encoding":"UTF-8","RoxygenNote":"7.3.3","Config/testthat/edition":"3","Config/build/clean-inst-doc":"false","VignetteBuilder":"knitr","NeedsCompilation":"no","Packaged":"2026-02-24 10:54:56 UTC; u1004798","Author":"Edward Gillian [cre, aut] (ORCID:\n),\nHugo Bottois [aut] (ORCID: ),\nPaulin Charliquart [aut],\nAndre Couturier [aut],\nSanofi [cph, fnd]","Maintainer":"Edward Gillian ","Repository":"CRAN","Date/Publication":"2026-03-02 22:20:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/test.assessr_1.1.1.tar.gz","jsonAuthors":[{"name":"Edward Gillian","email":"edward.gillian-ext@sanofi.com","maintainer":true},{"name":"Hugo Bottois","email":"hugo.bottois@sanofi.com","maintainer":false},{"name":"Paulin Charliquart","email":"paulin.charliquart@sanofi.com","maintainer":false},{"name":"Andre Couturier","email":"andre.couturier@sanofi.com","maintainer":false},{"name":"Sanofi ","email":null,"maintainer":false}],"readme":"\n\n# test.assessr

\n\n\n\n![R-CMD-check](https://img.shields.io/badge/R%20CMD%20check-Passing-brightgreen.svg)![Coverage](https://img.shields.io/badge/coverage-96%25-brightgreen.svg)\n\n\n\n\n# Overview\n\ntest.assessr helps in the assessment of a package's test reliability and validity. \n\nIt calculates unit test coverage for packages with standard testing frameworks \nand non-standard testing frameworks, including Bioconductor packages.\n\n# Description\n\nThis package executes the following tasks:\n\n1. upload the source package(`tar.gz` file)\n\n2. Unpack the `tar.gz` file\n\n3. Install the package locally\n\n4. Run code coverage\n\n\n# Package Installation\n\n## from [Github](https://github.com/Sanofi-Public/test.assessr)\n\n- Create a `Personal Access Token` (PAT) on `github`\n\n - Log into your `github` account\n - Go to the token settings URL using the [Token Settings URL](https://github.com/settings/tokens)\n - (do not forget to add the SSH `Sanofi-Public` authorization)\n\n- Create a `.Renviron` file with your GITHUBTOKEN as:\n\n\n\n``` \n# .Renviron\nGITHUBTOKEN=dfdxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxfdf\n```\n\n- restart R session\n- You can install the package with:\n\n\n\n``` \nauth_token = Sys.getenv(\"GITHUBTOKEN\")\ndevtools::install_github(\"Sanofi-Public/test.assessr\", ref = \"main\", auth_token = auth_token)\n```\n\n# Usage\n\n## Assessing your own package for test coverage\n\nTo assess your package's test coverage, do the following steps:\n\n1 - save your package as a `tar.gz` file\n\n- This can be done in `RStudio` -\\> `Build Tab` -\\> `More` -\\> `Build Source Package`\n\n2 - Run the following code sample by loading or add path parameter to your `tar.gz` package source code\n\n``` r\n# for local tar.gz R package\ndp <- (path/to/your/package)\n\ntest_package_coverage <- get_package_coverage(dp)\n\ngenerate_test_report(test_package_coverage)\n\n```\n\n\n## `test.assessr` results\n\n\nFor a package with a standard testing framework such as `testthat` or `testit` \nor non-standard testing frameworks such as `BiocGenerics` and `RUnit`, \n`test_assessr` can provide data on which tests are passing and which tests are skipped.\n\nThe standard testing framework test report tells you which tests have passed: \n\n![](man/figures/tp0014-stf-tests-passing.png)\n\nThe report provides information on which test blocks have passed and the start \nline of each test block.\n\nThe standard testing framework test report tells you which tests have been skipped: \n\n![](man/figures/tp0014-stf-tests-skipped.png)\n\nThe report provides information on which test blocks have passed, \nexpectation type, and the start line of each test block.\n\nThe non-standard testing framework test report tells you which functions have no tests:\n\n![](man/figures/MASS-nstf-no-tests.png)\n\nThe report tells you which tests have passed: \n\n![](man/figures/MASS-nstf-tests-passing.png)\n\nThe test report tells you which tests have been skipped: \n\n![](man/figures/MASS-nstf-tests-skipped.png)\n\n\n# Current/Future directions\n\n- to develop methods for checking the validity of test data\n- to develop methods of checking mocks\n\n# Acknowledgements\n\nThe project is inspired by the [`covrpage`](https://github.com/yonicd/covrpage) and [`mpn.scorecard`](https://github.com/metrumresearchgroup/mpn.scorecard) packages and draws on some of their ideas and functions.","jobInfo":{"package":"test.assessr","version":"1.1.1","parsingStatus":"success","parserVersion":2,"parsedAt":"2026-03-02T23:29:58+0000"}}

Description

Usage

Arguments