Skip to content

Commit 772124b

Browse files
mpadgempadge
committed
spaceout readme
1 parent 4c3a7c8 commit 772124b

File tree

4 files changed

+97
-95
lines changed

4 files changed

+97
-95
lines changed

‎DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: autotest
22
Title: Automatic Package Testing
3-
Version: 0.0.2.206
3+
Version: 0.0.2.207
44
Authors@R: c(
55
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0003-2172-5265")),

‎README.Rmd

+20-17
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ output:
1313
<!-- README.md is generated from README.Rmd. Please edit that file -->
1414

1515
```{r setup, include=FALSE}
16-
knitr::opts_chunk$set(
17-
collapse = TRUE,
18-
warning = TRUE,
19-
message = TRUE,
20-
width = 120,
21-
comment = "#>",
22-
fig.retina = 2,
23-
fig.path = "README-"
16+
knitr::opts_chunk$set (
17+
collapse = TRUE,
18+
warning = TRUE,
19+
message = TRUE,
20+
width = 120,
21+
comment = "#>",
22+
fig.retina = 2,
23+
fig.path = "README-"
2424
)
2525
```
2626

@@ -47,26 +47,27 @@ The easiest way to install this package is via the associated
4747
shown there, simply enable the universe with
4848

4949
```{r options, eval = FALSE}
50-
options(repos = c(
50+
options (repos = c (
5151
ropenscireviewtools = "https://ropensci-review-tools.r-universe.dev",
52-
CRAN = "https://cloud.r-project.org"))
52+
CRAN = "https://cloud.r-project.org"
53+
))
5354
```
5455

5556
And then install the usual way with,
5657

5758
```{r install, eval = FALSE}
58-
install.packages("autotest")
59+
install.packages ("autotest")
5960
```
6061

6162
Alternatively, the package can be installed by running one of the following
6263
lines:
6364

6465
```{r gh-installation, eval = FALSE}
6566
# install.packages("remotes")
66-
remotes::install_git("https://git.sr.ht/~mpadge/autotest")
67-
remotes::install_bitbucket("mpadge/autotest")
68-
remotes::install_gitlab("mpadge/autotest")
69-
remotes::install_github("ropensci-review-tools/autotest")
67+
remotes::install_git ("https://git.sr.ht/~mpadge/autotest")
68+
remotes::install_bitbucket ("mpadge/autotest")
69+
remotes::install_gitlab ("mpadge/autotest")
70+
remotes::install_github ("ropensci-review-tools/autotest")
7071
```
7172

7273
The package can then be loaded the usual way:
@@ -169,8 +170,10 @@ tests which are to be switched off.
169170

170171
```{r stats-var-test-switch}
171172
types <- autotest_types (notest = "vector_to_list_col")
172-
y <- autotest_package (package = "stats", functions = "var",
173-
test = TRUE, test_data = types)
173+
y <- autotest_package (
174+
package = "stats", functions = "var",
175+
test = TRUE, test_data = types
176+
)
174177
print (y)
175178
```
176179

‎README.md

+75-76
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,27 @@ The easiest way to install this package is via the associated
2222
As shown there, simply enable the universe with
2323

2424
``` r
25-
options(repos = c(
25+
options (repos = c (
2626
ropenscireviewtools = "https://ropensci-review-tools.r-universe.dev",
27-
CRAN = "https://cloud.r-project.org"))
27+
CRAN = "https://cloud.r-project.org"
28+
))
2829
```
2930

3031
And then install the usual way with,
3132

3233
``` r
33-
install.packages("autotest")
34+
install.packages ("autotest")
3435
```
3536

3637
Alternatively, the package can be installed by running one of the
3738
following lines:
3839

3940
``` r
4041
# install.packages("remotes")
41-
remotes::install_git("https://git.sr.ht/~mpadge/autotest")
42-
remotes::install_bitbucket("mpadge/autotest")
43-
remotes::install_gitlab("mpadge/autotest")
44-
remotes::install_github("ropensci-review-tools/autotest")
42+
remotes::install_git ("https://git.sr.ht/~mpadge/autotest")
43+
remotes::install_bitbucket ("mpadge/autotest")
44+
remotes::install_gitlab ("mpadge/autotest")
45+
remotes::install_github ("ropensci-review-tools/autotest")
4546
```
4647

4748
The package can then be loaded the usual way:
@@ -86,19 +87,19 @@ implemented.
8687
``` r
8788
autotest_types ()
8889
#> # A tibble: 27 × 8
89-
#> type test_name fn_name parameter parameter_type operation content test
90-
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <lgl>
91-
#> 1 dummy rect_as_o… <NA> <NA> rectangular Convert on… "check f… TRUE
92-
#> 2 dummy rect_comp… <NA> <NA> rectangular Convert on… "expect … TRUE
93-
#> 3 dummy rect_comp… <NA> <NA> rectangular Convert on… "expect … TRUE
94-
#> 4 dummy rect_comp… <NA> <NA> rectangular Convert on… "expect … TRUE
95-
#> 5 dummy extend_re… <NA> <NA> rectangular Extend exi… "(Should… TRUE
96-
#> 6 dummy replace_r… <NA> <NA> rectangular Replace cl… "(Should… TRUE
97-
#> 7 dummy vector_to… <NA> <NA> vector Convert ve… "(Should… TRUE
98-
#> 8 dummy vector_cu… <NA> <NA> vector Custom cla… "(Should… TRUE
99-
#> 9 dummy double_is… <NA> <NA> numeric Check whet… "int par… TRUE
100-
#> 10 dummy trivial_n… <NA> <NA> numeric Add trivia… "(Should… TRUE
101-
#> # … with 17 more rows
90+
#> type test_name fn_name parameter parameter_type operation content test
91+
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <lgl>
92+
#> 1 dummy rect_as_other <NA> <NA> rectangular Convert … "check… TRUE
93+
#> 2 dummy rect_compare_… <NA> <NA> rectangular Convert … "expec… TRUE
94+
#> 3 dummy rect_compare_… <NA> <NA> rectangular Convert … "expec… TRUE
95+
#> 4 dummy rect_compare_… <NA> <NA> rectangular Convert … "expec… TRUE
96+
#> 5 dummy extend_rect_c… <NA> <NA> rectangular Extend e… "(Shou… TRUE
97+
#> 6 dummy replace_rect_… <NA> <NA> rectangular Replace … "(Shou… TRUE
98+
#> 7 dummy vector_to_lis… <NA> <NA> vector Convert … "(Shou… TRUE
99+
#> 8 dummy vector_custom… <NA> <NA> vector Custom c… "(Shou… TRUE
100+
#> 9 dummy double_is_int <NA> <NA> numeric Check wh… "int p… TRUE
101+
#> 10 dummy trivial_noise <NA> <NA> numeric Add triv… "(Shou… TRUE
102+
#> # ℹ 17 more rows
102103
```
103104

104105
That functions returns a [`tibble`](https://tibble.tidyverse.org)
@@ -134,28 +135,29 @@ x <- autotest_package (package = "stats", functions = "var", test = FALSE)
134135
#> ✔ [5 / 6]: cov
135136
#> ✔ [6 / 6]: cor
136137
print (x)
137-
#> # A tibble: 185 × 9
138-
#> type test_name fn_name parameter parameter_type operation content test
139-
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <lgl>
140-
#> 1 warning par_is_de… var use <NA> Check tha… Example… TRUE
141-
#> 2 warning par_is_de… cov y <NA> Check tha… Example… TRUE
142-
#> 3 dummy trivial_n… var x numeric Add trivi… (Should… TRUE
143-
#> 4 dummy vector_cu… var x vector Custom cl… (Should… TRUE
144-
#> 5 dummy vector_to… var x vector Convert v… (Should… TRUE
145-
#> 6 dummy negate_lo… var na.rm single logical Negate de… (Functi… TRUE
146-
#> 7 dummy subst_int… var na.rm single logical Substitut… (Functi… TRUE
147-
#> 8 dummy subst_cha… var na.rm single logical Substitut… should … TRUE
148-
#> 9 dummy single_pa… var na.rm single logical Length 2 … Should … TRUE
149-
#> 10 dummy return_su… var (return … (return objec… Check tha… <NA> TRUE
150-
#> # … with 175 more rows, and 1 more variable: yaml_hash <chr>
138+
#> # A tibble: 170 × 9
139+
#> type test_name fn_name parameter parameter_type operation content test
140+
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <lgl>
141+
#> 1 warning par_is_demo… var use <NA> Check th… Exampl… TRUE
142+
#> 2 warning par_is_demo… cov y <NA> Check th… Exampl… TRUE
143+
#> 3 dummy trivial_noi… var x numeric Add triv… (Shoul… TRUE
144+
#> 4 dummy vector_cust… var x vector Custom c… (Shoul… TRUE
145+
#> 5 dummy vector_to_l… var x vector Convert … (Shoul… TRUE
146+
#> 6 dummy negate_logi… var na.rm single logical Negate d… (Funct… TRUE
147+
#> 7 dummy subst_int_f… var na.rm single logical Substitu… (Funct… TRUE
148+
#> 8 dummy subst_char_… var na.rm single logical Substitu… should… TRUE
149+
#> 9 dummy single_par_… var na.rm single logical Length 2… Should… TRUE
150+
#> 10 dummy return_succ… var (return … (return objec… Check th… <NA> TRUE
151+
#> # ℹ 160 more rows
152+
#> # ℹ 1 more variable: yaml_hash <chr>
151153
```
152154

153155
Testing the `var` function also tests `cor` and `cov`, because these are
154156
all documented within a single `.Rd` help file. Typing `?var` shows that
155157
the help topic is `cor`, and that the examples include the three
156-
functions, `var`, `cor`, and `cov`. That result details the 185 tests
158+
functions, `var`, `cor`, and `cov`. That result details the 170 tests
157159
which would be applied to the `var` function from the `stats` package.
158-
These 185 tests yield the following results when actually applied:
160+
These 170 tests yield the following results when actually applied:
159161

160162
``` r
161163
y <- autotest_package (package = "stats", functions = "var", test = TRUE)
@@ -168,32 +170,34 @@ y <- autotest_package (package = "stats", functions = "var", test = TRUE)
168170
#> ✔ [5 / 6]: cov
169171
#> ✔ [6 / 6]: cor
170172
print (y)
171-
#> # A tibble: 23 × 9
173+
#> # A tibble: 25 × 9
172174
#> type test_name fn_name parameter parameter_type operation content test
173175
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <lgl>
174176
#> 1 warning par_is_d… var use <NA> Check th… "Examp… TRUE
175177
#> 2 warning par_is_d… cov y <NA> Check th… "Examp… TRUE
176178
#> 3 diagnostic vector_t… var x vector Convert … "Funct… TRUE
177-
#> 4 diagnostic vector_t… var x vector Convert … "Funct… TRUE
178-
#> 5 diagnostic vector_t… var y vector Convert … "Funct… TRUE
179-
#> 6 diagnostic single_c… cor use single charac… upper-ca… "is ca… TRUE
180-
#> 7 diagnostic single_c… cor method single charac… upper-ca… "is ca… TRUE
181-
#> 8 diagnostic vector_c… cor x vector Custom c… "Funct… TRUE
182-
#> 9 diagnostic single_c… cor method single charac… upper-ca… "is ca… TRUE
183-
#> 10 diagnostic single_c… cor use single charac… upper-ca… "is ca… TRUE
184-
#> # … with 13 more rows, and 1 more variable: yaml_hash <chr>
179+
#> 4 diagnostic subst_in… var na.rm single logical Substitu… "(Func… TRUE
180+
#> 5 diagnostic vector_t… var x vector Convert … "Funct… TRUE
181+
#> 6 diagnostic vector_t… var y vector Convert … "Funct… TRUE
182+
#> 7 diagnostic single_c… cor use single charac… upper-ca… "is ca… TRUE
183+
#> 8 diagnostic single_c… cor method single charac… upper-ca… "is ca… TRUE
184+
#> 9 diagnostic vector_c… cor x vector Custom c… "Funct… TRUE
185+
#> 10 diagnostic vector_c… cor x vector Custom c… "Funct… TRUE
186+
#> # ℹ 15 more rows
187+
#> # ℹ 1 more variable: yaml_hash <chr>
185188
```
186189

187-
And only 23 of the original 185 tests produced unexpected behaviour.
188-
There were in fact only 4 kinds of tests which produced these 23
190+
And only 25 of the original 170 tests produced unexpected behaviour.
191+
There were in fact only 5 kinds of tests which produced these 25
189192
results:
190193

191194
``` r
192195
unique (y$operation)
193-
#> [1] "Check that parameter usage is demonstrated"
194-
#> [2] "Convert vector input to list-columns"
195-
#> [3] "upper-case character parameter"
196-
#> [4] "Custom class definitions for vector input"
196+
#> [1] "Check that parameter usage is demonstrated"
197+
#> [2] "Convert vector input to list-columns"
198+
#> [3] "Substitute integer values for logical parameter"
199+
#> [4] "upper-case character parameter"
200+
#> [5] "Custom class definitions for vector input"
197201
```
198202

199203
One of these involves conversion of a vector to a list-column
@@ -207,8 +211,10 @@ switched off.
207211

208212
``` r
209213
types <- autotest_types (notest = "vector_to_list_col")
210-
y <- autotest_package (package = "stats", functions = "var",
211-
test = TRUE, test_data = types)
214+
y <- autotest_package (
215+
package = "stats", functions = "var",
216+
test = TRUE, test_data = types
217+
)
212218
#> ── autotesting stats ──
213219
#>
214220
#> ✔ [1 / 6]: var
@@ -218,20 +224,21 @@ y <- autotest_package (package = "stats", functions = "var",
218224
#> ✔ [5 / 6]: cov
219225
#> ✔ [6 / 6]: cor
220226
print (y)
221-
#> # A tibble: 28 × 9
227+
#> # A tibble: 22 × 9
222228
#> type test_name fn_name parameter parameter_type operation content test
223229
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <lgl>
224230
#> 1 warning par_is_d… var use <NA> Check th… Exampl… TRUE
225231
#> 2 warning par_is_d… cov y <NA> Check th… Exampl… TRUE
226-
#> 3 diagnostic single_c… cor use single charac… upper-ca… is cas… TRUE
227-
#> 4 diagnostic single_c… cor method single charac… upper-ca… is cas… TRUE
228-
#> 5 diagnostic vector_c… cor x vector Custom c… Functi… TRUE
229-
#> 6 diagnostic single_c… cor method single charac… upper-ca… is cas… TRUE
230-
#> 7 diagnostic single_c… cor use single charac… upper-ca… is cas… TRUE
231-
#> 8 diagnostic single_c… cor use single charac… upper-ca… is cas… TRUE
232-
#> 9 diagnostic single_c… cor method single charac… upper-ca… is cas… TRUE
233-
#> 10 diagnostic vector_c… cov x vector Custom c… Functi… TRUE
234-
#> # … with 18 more rows, and 1 more variable: yaml_hash <chr>
232+
#> 3 diagnostic subst_in… var na.rm single logical Substitu… (Funct… TRUE
233+
#> 4 diagnostic single_c… cor use single charac… upper-ca… is cas… TRUE
234+
#> 5 diagnostic single_c… cor method single charac… upper-ca… is cas… TRUE
235+
#> 6 diagnostic vector_c… cor x vector Custom c… Functi… TRUE
236+
#> 7 diagnostic vector_c… cor x vector Custom c… Functi… TRUE
237+
#> 8 diagnostic single_c… cor method single charac… upper-ca… is cas… TRUE
238+
#> 9 diagnostic single_c… cor use single charac… upper-ca… is cas… TRUE
239+
#> 10 diagnostic single_c… cor use single charac… upper-ca… is cas… TRUE
240+
#> # ℹ 12 more rows
241+
#> # ℹ 1 more variable: yaml_hash <chr>
235242
```
236243

237244
Those tests are still returned from `autotest_package()`, but with
@@ -266,17 +273,19 @@ project, you agree to abide by its terms.
266273

267274
## Contributors
268275

269-
270276
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
271277
<!-- prettier-ignore-start -->
272278
<!-- markdownlint-disable -->
273279

274-
All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropenscilabs/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
280+
All contributions to this project are gratefully acknowledged using the
281+
[`allcontributors`
282+
package](https://github.com/ropenscilabs/allcontributors) following the
283+
[all-contributors](https://allcontributors.org) specification.
284+
Contributions of any kind are welcome!
275285

276286
### Code
277287

278288
<table>
279-
280289
<tr>
281290
<td align="center">
282291
<a href="https://github.com/mpadge">
@@ -303,14 +312,11 @@ All contributions to this project are gratefully acknowledged using the [`allcon
303312
<a href="https://github.com/ropensci-review-tools/autotest/commits?author=simpar1471">simpar1471</a>
304313
</td>
305314
</tr>
306-
307315
</table>
308316

309-
310317
### Issue Authors
311318

312319
<table>
313-
314320
<tr>
315321
<td align="center">
316322
<a href="https://github.com/noamross">
@@ -355,8 +361,6 @@ All contributions to this project are gratefully acknowledged using the [`allcon
355361
<a href="https://github.com/ropensci-review-tools/autotest/issues?q=is%3Aissue+author%3Astatnmap">statnmap</a>
356362
</td>
357363
</tr>
358-
359-
360364
<tr>
361365
<td align="center">
362366
<a href="https://github.com/vgherard">
@@ -389,14 +393,11 @@ All contributions to this project are gratefully acknowledged using the [`allcon
389393
<a href="https://github.com/ropensci-review-tools/autotest/issues?q=is%3Aissue+author%3Agilbertocamara">gilbertocamara</a>
390394
</td>
391395
</tr>
392-
393396
</table>
394397

395-
396398
### Issue Contributors
397399

398400
<table>
399-
400401
<tr>
401402
<td align="center">
402403
<a href="https://github.com/schneiderpy">
@@ -405,9 +406,7 @@ All contributions to this project are gratefully acknowledged using the [`allcon
405406
<a href="https://github.com/ropensci-review-tools/autotest/issues?q=is%3Aissue+commenter%3Aschneiderpy">schneiderpy</a>
406407
</td>
407408
</tr>
408-
409409
</table>
410-
411410
<!-- markdownlint-enable -->
412411
<!-- prettier-ignore-end -->
413412
<!-- ALL-CONTRIBUTORS-LIST:END -->

‎codemeta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"codeRepository": "https://github.com/ropensci-review-tools/autotest",
99
"issueTracker": "https://github.com/ropensci-review-tools/autotest/issues",
1010
"license": "https://spdx.org/licenses/GPL-3.0",
11-
"version": "0.0.2.206",
11+
"version": "0.0.2.207",
1212
"programmingLanguage": {
1313
"@type": "ComputerLanguage",
1414
"name": "R",

0 commit comments

Comments
 (0)