Skip to content

Commit

Permalink
improve sections for inactive checks
Browse files Browse the repository at this point in the history
ref #5
  • Loading branch information
wibeasley committed Dec 31, 2021
1 parent 2045b09 commit 79983ce
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 36 deletions.
39 changes: 26 additions & 13 deletions inst/report-templates/rmarkdown-1/report-1.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,7 @@ Instructions
* the report code.
1. If you create a new rule or smell check, make sure the error message won't reveal any PHI.

Inactive Checks
-----------------------------

`r nrow(checks$rules_inactive)` rules(s) are disabled for this report:

```{r rules-inactive, echo = echo_chunks, results = 'asis'}
cat(sprintf("1. %s;", checks$rules_inactive$check_name), sep = "\n")
```

`r nrow(checks$smells_inactive)` smell(s) are disabled for this report:

```{r smells-inactive, echo = echo_chunks, results = 'asis'}
cat(sprintf("1. %s;", checks$smells_inactive$check_name), sep = "\n")
```

Rules {.tabset .tabset-fade}
=============================
Expand Down Expand Up @@ -209,6 +196,19 @@ checks$rules |>
}()
```

Inactive Rules
-----------------------------

<div style="background-color:#555;color:white;padding:20px;">
`r nrow(checks$rules_inactive)` rules(s) are disabled for this report:

```{r rules-inactive, echo = echo_chunks, results = 'asis'}
cat(sprintf("1. %s;", checks$rules_inactive$check_name), sep = "\n")
```

To enable/disable a rule, set the `active` element in the yaml checks file to "true" or "false".
</div>

Smells {.tabset .tabset-fade}
=============================

Expand Down Expand Up @@ -271,5 +271,18 @@ ds_smell_result_pretty |>
bold = TRUE,
background = palette_summary$warm
)
```

Inactive Smells
-----------------------------

<div style="background-color:#555;color:white;padding:20px;">

`r nrow(checks$smells_inactive)` smell(s) are disabled for this report:

```{r smells-inactive, echo = echo_chunks, results = 'asis'}
cat(sprintf("1. %s;", checks$smells_inactive$check_name), sep = "\n")
```

To enable/disable a smell, set the `active` element in the yaml checks file to "true" or "false".
</div>
Loading

0 comments on commit 79983ce

Please sign in to comment.