Skip to content

Commit 88f0b02

Browse files
authored
[skip vbump] Closes #482 Release the 1.2/kraken! πŸ¦‘ (#483)
* chore: #482 remove non-ascii characters * chore: #482 remove ascii chars, remove [] for CRAN Note * docs: #482 remove dev versions * chore: #482 removed unused words from spelling list
1 parent 0b222b4 commit 88f0b02

File tree

9 files changed

+19
-22
lines changed

9 files changed

+19
-22
lines changed

β€ŽDESCRIPTIONβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Type: Package
22
Package: admiraldev
33
Title: Utility Functions and Development Tools for the Admiral Package
44
Family
5-
Version: 1.1.0.9009
5+
Version: 1.2.0
66
Authors@R: c(
77
person("Ben", "Straub", , "ben.x.straub@gsk.com", role = c("aut", "cre")),
88
person("Stefan", "Bundfuss", role = "aut",

β€ŽNEWS.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# admiraldev (development version)
1+
# admiraldev 1.2.0
22

33
## New Features
44

β€ŽR/dev_utilities.Rβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ contains_vars <- function(arg) {
150150

151151
#' Turn a List of Expressions into a Character Vector
152152
#'
153-
#' @param expressions A `list` of expressions created using [`exprs()`]
153+
#' @param expressions A `list` of expressions created using `exprs()`
154154
#'
155155
#' @return A character vector
156156
#'

β€Žinst/WORDLISTβ€Ž

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,11 @@ datatable
7272
datetime
7373
datetimes
7474
dev
75-
developers’
7675
devs
7776
dplyr
7877
dtc
7978
exprs
8079
flexibilities
81-
functions’
8280
funder
8381
hotfix
8482
hotfixes
@@ -94,7 +92,6 @@ pre
9492
proc
9593
programmatically
9694
quosures
97-
regexpr
9895
repo
9996
reproducibility
10097
roxygen

β€Žman/vars2chr.Rdβ€Ž

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žvignettes/programming_strategy.Rmdβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ documentation of `set_admiral_options()`.
128128

129129
| Function name prefix | Description |
130130
|----------------------------------------------|-----------------------------------------------------------------------------------------------------|
131-
| `assert_` / `warn_` / `is_` | Functions that check other functions’ inputs |
131+
| `assert_` / `warn_` / `is_` | Functions that check other functions' inputs |
132132
| `derive_` | Functions that take a dataset as input and return a new dataset with additional rows and/or columns |
133133
| `derive_var_` (e.g. `derive_var_trtdurd`) | Functions which add a single variable |
134134
| `derive_vars_` (e.g. `derive_vars_dt`) | Functions which add multiple variables |
@@ -299,7 +299,7 @@ for outline entries) must be added.
299299

300300
In line with the [fail-fast](https://en.wikipedia.org/wiki/Fail-fast) design principle,
301301
function inputs should be checked for validity
302-
and, if there’s an invalid input, the function should stop immediately with an error.
302+
and, if there's an invalid input, the function should stop immediately with an error.
303303
An exception is the case where a variable to be added by a function already exists in the input dataset:
304304
here only a warning should be displayed and the function should continue executing.
305305

β€Žvignettes/rcmd_issues.Rmdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,22 +67,22 @@ This will ensure that the exact package versions we use in the workflow are inst
6767
## Package Dependencies
6868

6969
> checking package dependencies ... ERROR
70-
Namespace dependency not required: β€˜pkg’
70+
Namespace dependency not required: 'pkg'
7171

7272
Add `pkg` to the `Imports` or `Suggests` field in the `DESCRIPTION` file. In general, dependencies should be listed in the `Imports` field. However, if a package is only used inside vignettes or unit tests it should be listed in `Suggests` because all `{admiral}` functions would work without these "soft" dependencies being installed.
7373

7474
## Global Variables
7575

7676
❯ checking R code for possible problems ... NOTE
77-
function_xyz: no visible binding for global variable β€˜some_var’
77+
function_xyz: no visible binding for global variable 'some_var'
7878

7979
Add `some_var` to the list of "global" variables in `R/globals.R`.
8080

8181
## Undocumented Function Parameter
8282

8383
❯ checking Rd \usage sections ... WARNING
8484
Undocumented arguments in documentation object 'function_xyz'
85-
β€˜some_param’
85+
'some_param'
8686

8787
Add an `@param some_param` section in the header of `function_xyz()` and run `devtools::document()` afterwards.
8888

β€Žvignettes/unit_test_guidance.Rmdβ€Ž

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ knitr::opts_chunk$set(
2323

2424
A comprehensive suite of unit tests can act as a safety net for developers. By
2525
frequently running the tests, they can assure their recent modifications to the
26-
code haven’t broken anything. In other words, unit tests help prevent regressions.
26+
code haven't broken anything. In other words, unit tests help prevent regressions.
2727

2828
## Unit Tests Can Contribute to Higher Code Quality
2929

@@ -33,8 +33,8 @@ driving the general quality of the code base up.
3333

3434
## Unit Tests Can Contribute to Better Application Architecture
3535

36-
If you can add unit tests easily to a code base, that’s usually a good sign
37-
regarding the quality of the app’s architecture. So, the drive to write testable
36+
If you can add unit tests easily to a code base, that's usually a good sign
37+
regarding the quality of the app's architecture. So, the drive to write testable
3838
code can be an incentive for better architecture.
3939

4040
## Detects Code Smells in your Codebase
@@ -47,10 +47,10 @@ a sign of code smells in the codeβ€”e.g. functions that are too complex.
4747

4848
## Tests Should Be Fast
4949

50-
If they’re slow, developers won’t run them as often as they should. That defeats
50+
If they're slow, developers won't run them as often as they should. That defeats
5151
the whole purpose of having a suite of unit tests in the first place, which is
52-
to boost the developers’ confidence to make changes to the code. The tests can’t
53-
work as the safety net if they’re not run often.
52+
to boost the developers' confidence to make changes to the code. The tests can't
53+
work as the safety net if they're not run often.
5454

5555
## Tests Should Be Simple
5656

@@ -63,9 +63,9 @@ are less likely to introduce bugs when working on it. We can measure the
6363
cyclomatic complexity of your tests (using, for instance, a linter tool) and do
6464
your best to keep it low.
6565

66-
## Test Shouldn’t Duplicate Implementation Logic
66+
## Test Shouldn't Duplicate Implementation Logic
6767

68-
If the same person wrote both the test and the implementation, it’s possible they
68+
If the same person wrote both the test and the implementation, it's possible they
6969
made the same errors in both places. Since the tests mirror the implementation,
7070
they might still pass, and the implementation could be wrong, but the tests might
7171
fool you into thinking otherwise. Resist the urge to make your tests fancy, keep
@@ -119,7 +119,7 @@ your function justifies it, e.g. see the test script: https://github.com/pharmav
119119

120120
## Exported Functions
121121

122-
Don’t forget to add a unit test for each exported function.
122+
Don't forget to add a unit test for each exported function.
123123

124124
## Snapshot Testing
125125

β€Žvignettes/writing_vignettes.Rmdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ affected.
189189

190190
Footnotes can be useful to add context without adding clutter to the primary subject matter of the vignette being written.
191191

192-
To use footnotes, add a caret and an identifier inside brackets e.g. `([^1])`. The identifiers can be numbers or words, but they can’t contain spaces or tabs.
192+
To use footnotes, add a caret and an identifier inside brackets e.g. `([^1])`. The identifiers can be numbers or words, but they can't contain spaces or tabs.
193193

194194
The following markdown text will render as follows:
195195

0 commit comments

Comments
Β (0)