Improve the looks of the report

.Rbuildignore

@@ -10,5 +10,7 @@ inst/source/*
 inst/source/Library
 inst/source/*Rcheck
 inst/source/*tar.gz
-inst/*.rds = = = = =
-=
+inst/*.rds
+_pkgdown.yaml
+pkgdown
+.github

DESCRIPTION

@@ -1,12 +1,12 @@
 Package: riskreports
 Title: Package Validation Reports
-Version: 0.0.0.9004
+Version: 0.0.0.9006
 Authors@R: c(
     person("Lluís", "Revilla Sancho", , "lluis.revilla_sancho@roche.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-9747-2570")),
     person("R Validation Hub", role = "cph", email = "r-val-hub-maintainers@lists.r-consortium.org")
   )
-Description: Documents package checks for validation in a pharmaceutic
+Description: Documents package checks for validation in a pharmaceutic 
     context.
 License: MIT + file LICENSE
 URL: https://github.com/pharmaR/riskreports, https://pharmar.github.io/riskreports/

NAMESPACE

@@ -5,5 +5,6 @@ export(check_reporter)
 export(environ_report)
 export(options_report)
 export(package_report)
+export(summary_table)
 importFrom(methods,is)
 importFrom(tools,check_packages_in_dir_details)

R/riskmetic.R

@@ -52,3 +52,39 @@ risk_error <- function(output, y) {
   }
   y
 }
+
+is_logical <- function(x) {
+  if (x == 1 || isTRUE(x)) {
+    "Yes"
+  } else {
+    x
+  }
+}
+
+simple_cap <- function(x) {
+  s <- toupper(substr(x, 1, 1))
+  paste0(s, substring(x, 2))
+}
+
+#' Summary table
+#'
+#' @param risk The output of `assessment()`.
+#'
+#' @returns A data.frame with the two columns one for the fields and one for the values.
+#' @export
+summary_table <- function(risk) {
+  y <- risk
+  y[] <- lapply(y, is_logical)
+  y$has_examples <- sprintf("%.2f%%", y$has_examples*100)
+  y$bugs_status <- sprintf("%.2f%%", y$bugs_status*100)
+  if (y$has_vignettes > 0) {
+    y$has_vignettes <- "Yes"
+  }
+  x <- t(y)
+  yx <- simple_cap(gsub("_", " ", rownames(x), fixed = TRUE))
+  df <- as.data.frame(x)
+  df <- cbind(Section = yx, Values = df)
+  colnames(df) <- c("Section", "Values")
+  rownames(df) <- NULL
+  df
+}

inst/report/pkg_template.qmd

@@ -7,19 +7,20 @@ params:
   package: NULL
   image: "rhub/ref-image"
   assessment_path: "assessments/dplyr.rds"
+  hide_reverse_deps: true
 format:
   html: 
     toc: true  
     embed-resources: true
   gfm:
     html-math-method: webtex    
-  # typst:
-  #   toc: true
-  #   section-numbering: 1.1.1
-  #   df-print: default
-  #   margin:
-  #     x: 2cm
-  #     y: 2cm
+  typst:
+    toc: true
+    section-numbering: 1.1.1
+    df-print: default
+    margin:
+      x: 2cm
+      y: 2cm
 ---
 
 ```{r setup, include = FALSE}
@@ -31,6 +32,16 @@ knitr::opts_chunk$set(
     cache = FALSE
 )
 library("tools")
+# Adapted from https://stackoverflow.com/a/52327256
+library("knitr")
+hook_old <- knitr::knit_hooks$get("output")
+knit_hooks$set(output = function(x, options) {
+  if (!is.null(options$summary)){
+      x <- paste0("<details><br><summary>", options$summary,"</summary><br>", hook_old(x, options), "<br></details>")
+  } 
+  x
+})
+
 ```
 
 # Context
@@ -82,8 +93,11 @@ d_riskmetric <- readRDS(risk_path)
 
 # Assesment produces a data.frame with one row
 r_riskmetric <- riskreports::assessment(d_riskmetric)
-is_na <- sapply(r_riskmetric, function(x){is.na(x) || (is.character(x) && startsWith(x, "no applicable"))})
-knitr::kable(t(r_riskmetric[, !is_na])) # Use this to have some summary text and report it.
+is_na <- sapply(x, function(x) {
+    is.na(x) || (is.character(x) && startsWith(x, "no applicable"))
+  })
+x <- summary_table(r_riskmetric[, !is_na])
+knitr::kable(x, row.names = FALSE align = "cc") # Use this to have some summary text and report it.
 # d_riskmetric
 ```
 
@@ -100,6 +114,8 @@ row.names(deps) <- NULL
 knitr::kable(deps, row.names = TRUE)
 ```
 
+::: {.content-hidden unless-meta="hide_reverse_deps"}
+
 ## Reverse dependencies
 
 Overall the package has `r length(d_riskmetric$reverse_dependencies)` reverse dependencies:
@@ -108,6 +124,8 @@ Overall the package has `r length(d_riskmetric$reverse_dependencies)` reverse de
 cat(paste(d_riskmetric$reverse_dependencies, collapse = ", "))
 ```
 
+:::
+
 ## Namespace
 
 Overall the package has `r length(d_riskmetric$exported_namespace)` exported objects.
@@ -117,15 +135,15 @@ Overall the package has `r length(d_riskmetric$exported_namespace)` exported obj
 d_riskmetric$export_help[sort(d_riskmetric$exported_namespace)]
 ```
 
-### Examples
+## Examples
 
 There are `r if (!is_na["has_examples"]) sum(d_riskmetric$has_examples)` help pages with examples, from `r if (!is_na["has_examples"]) {length(d_riskmetric$has_examples)}` (`r if (!is_na["has_examples"]) {sprintf("%0.2f", sum(d_riskmetric$has_examples)/length(d_riskmetric$has_examples)*100)} else {"?"} ` %).
 
-### NEWS
+## NEWS
 
 The package has `r if ("has_news" %in% names(d_riskmetric) && !is.null(d_riskmetric$has_news)) print(d_riskmetric$has_news)` NEWS file and it is `r if (is.null(d_riskmetric$news_current) && !d_riskmetric$news_current) "not"` current.
 
-### License
+## License
 
 The package uses `r if ("license" %in% names(d_riskmetric) && !is.null(d_riskmetric$license)) print(d_riskmetric$license)`.
 
@@ -167,7 +185,7 @@ unlist(.Platform)
 
 R's capabilities:
 
-```{r capabilities}
+```{r capabilities, summary = "Capabilities details"}
 capabilities()
 ```
 

pkgdown/favicon/site.webmanifest

@@ -0,0 +1,21 @@
+{
+  "name": "",
+  "short_name": "",
+  "icons": [
+    {
+      "src": "/web-app-manifest-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "/web-app-manifest-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png",
+      "purpose": "maskable"
+    }
+  ],
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff",
+  "display": "standalone"
+}