Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
walkowif committed May 9, 2024
1 parent f9c6451 commit ad37622
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ jobs:
if: success()
with:
name: ${{ matrix.package.name }} validation report
path: ${{ steps.validation.outputs.report_output_filename }}
path: validation_report.pdf
if-no-files-found: error
2 changes: 1 addition & 1 deletion .github/workflows/test_no_cache.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ jobs:
if: success()
with:
name: ${{ matrix.package.name }} validation report
path: ${{ steps.validation.outputs.report_output_filename }}
path: validation_report.pdf
if-no-files-found: error
23 changes: 20 additions & 3 deletions template.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,21 @@ This report is fully automated, so is limited to assess whether unit tests and d
## System Info

```{r execution_info, echo = FALSE}
data.frame(
tt_sys_info_df <- data.frame(
Field = c("OS", "Platform", "System", "Execution Time"),
Value = c(
sessionInfo()$running,
R.version$platform,
R.version$system,
format(Sys.time(), tz = "UTC", usetz = TRUE)
))
)) %>%
dplyr::mutate(Value = paste0("``` ", Value, " ```"))
tt(
tt_sys_info_df,
caption = "System information",
theme = "striped"
)
```

## Package installed
Expand Down Expand Up @@ -80,7 +87,8 @@ tt_git_df <- data.frame(
list(gd, wt, "show", "-s", "--format=%ci", "HEAD"),
stdout = TRUE
)
))
)) %>%
dplyr::mutate(Value = paste0("``` ", Value, " ```"))
tt(
tt_git_df,
Expand Down Expand Up @@ -207,15 +215,22 @@ if (require("covtracer", quietly = TRUE)) {
}
```

```{=typst}
#show figure: set block(breakable: false)
```

### Untested

```{r traceability2, echo = FALSE, eval = TRUE}
if (require("covtracer", quietly = TRUE)) {
tt_untested_df <- covtracer_df_clean %>%
dplyr::filter(is.na(test_name)) %>%
dplyr::arrange(alias) %>%
dplyr::mutate(alias = paste0("``` ", alias, " ```")) %>%
dplyr::mutate(file = paste0("``` ", file, " ```")) %>%
dplyr::select(`Exported package object` = alias, Documentation = file)
tt(
tt_untested_df,
caption = "Untested behaviours: documentation that is not covered by any test.",
Expand All @@ -236,6 +251,8 @@ if (require("covtracer", quietly = TRUE)) {
dplyr::group_by(alias) %>%
dplyr::summarize(any_direct_tests = any(direct, na.rm = TRUE)) %>%
dplyr::arrange(alias) %>%
dplyr::mutate(alias = paste0("``` ", alias, " ```")) %>%
dplyr::mutate(any_direct_tests = paste0("``` ", any_direct_tests, " ```")) %>%
dplyr::select(`Exported package object` = alias, `Tested Directly` = any_direct_tests)
tt(
Expand Down
5 changes: 5 additions & 0 deletions tests/packages/buckbeak/validation-template.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@ date: "`r Sys.time()`"
date-format: "ddd MMM DD hh:mm:ss A YYYY"
format:
typst:
toc: true
section-numbering: 1.1.1
df-print: default
margin:
x: 2cm
y: 2cm
---

```{r, include = FALSE}
Expand Down

0 comments on commit ad37622

Please sign in to comment.