doc

Author: [email protected]

R/open_testfile.R

@@ -1,9 +1,10 @@
-#' Open associated test_file
+#' Open associated test file
 #'
 #' If the currently open file in the RStudio editor is called \file{myfun.R} this
 #' opens \file{tests/testthat/test_myfun.R} in a new tab. This function can also
-#' be used to jump back and forth between an R script and the associated test
-#' file.
+#' be used to jump back and forth between a script and the associated test
+#' file. You can modify this behaviour by putting the comment
+#' `#* @testfile anotherfile` anywhere in \file{myfun.R}.
 #'
 #' @export
 open_testfile <- function(){

R/test_coverage.R

@@ -1,18 +1,16 @@
-#' Get Test Coverage of Package
+#' Test coverage of package
 #'
-#' This extracts the test coverage of the target package (usually the package
-#' you are working on). Bear in mind that testthis uses a checklist-approach for
-#' this, and depends that you either put the function name in your
-#' `test_that()` calls, or used test_this tags. If you want automatic
-#' analysis of test coverage, you must look in other packages such as `covr`.
+#' This determines the test coverage of the target package based on the `desc`
+#' argument of `test_that()` calls. If you require a more comprehensive analysis
+#' of thest coverage, try the package **covr** instead.
 #'
 #' `test_coverage` looks in `.covrignore` for functions that should be ignored
 #' for coverage analysis (see [usethis::use_covr_ignore()])
 #'
-#' @param from_tags Logical scalar. Checks the files if your test directory for
+#' @param from_tags `logical` scalar. Checks the files if your test directory for
 #'   testthis tags. Specifically, if you have the comment `#* @testing myfunction`
 #'   in any of your test files, myfunction will be marked as tested.
-#' @param from_desc Logical scalar. Checks the `desc` argument
+#' @param from_desc `logical` scalar. Checks the `desc` argument
 #'   `test_that(...)` of the tests in your test directory for functions
 #'   names. E.g. if you have a testfile that contains
 #'   `test_that("myfunction works", {...})`, myfunction will be marked as

R/test_index.R

@@ -3,8 +3,9 @@
 #' Generates an index the `desc` arguments of all `test_that()` calls in the
 #' `tests/testthat` directory of a package.
 #'
-#' @param markers `logical` scalar. Display RStudio markers. If `FALSE`, the
-#'   index is printed to the console instead.
+#' @param markers `logical` scalar. If `TRUE`, new markers are created in the
+#'   RStudio markers pane. If `FALSE`, the index is printed to the console
+#'   instead.
 #'
 #' @return A `test_index` `data.frame` (invisibly if `markers == TRUE`)
 #' @export

R/test_skeleton.R

@@ -7,10 +7,10 @@
 #' @section Side effects:
 #'   Creates an R script file in the file system.
 #'
-#' @param fname Character scalar. Target R script file to open. If empty the file
+#' @param fname `character` scalar. Target R script file to open. If empty the file
 #'   currently open in the editor will be used.
-#' @param open Logical scalar. Should the test file be opened after it is created?
-#' @param sep Character scalar. Separator between \file{test} and \file{fname}
+#' @param open `logical` scalar. Should the test file be opened after it is created?
+#' @param sep `character` scalar. Separator between \file{test} and \file{fname}
 #'   when constructing the test file name. Should either be `"_"` or `"-"` for
 #'   compatibility with testthat.
 #'

R/test_subdir.R

@@ -35,12 +35,12 @@
 #' own test subdirs instead.
 #'
 #' @inheritParams devtools::test
-#' @param subdir subdir of `inst/tests/` or `tests/testthat` that contains the
-#'   tests
+#' @param subdir `character` scalar. subdir of `inst/tests/` or `tests/testthat`
+#'   that contains the tests
 #' @param ... passed on to `devtools::test()`
 #' @seealso [`use_test_subdir()`]
 #'
-#' @return A [testthat_results] object (invisibly)
+#' @return A [testthat::testthat_results] object (invisibly)
 #'
 #' @export
 test_subdir <- function(subdir, ...){

R/test_this.R

@@ -7,7 +7,7 @@
 #' call `testthat::test_file()` on the current file.
 #'
 #' This is useful in cases where you don't want to run all tests in a package
-#' via `devtools::test()` (CTRL+SHIFT+T).
+#' via `devtools::test()` (CTRL+SHIFT+T in RStudio).
 #'
 #' @param ... passed on to [testthat::test_file()]
 #'

R/testthis-package.R

@@ -6,7 +6,8 @@
 #' testthis also provides utility function to manage tests in subdirectories of
 #' the test/testthis directory.
 #'
-#' For details please refer to `vignette("testthis")`
+#' For details please refer to the
+#' [README](https://s-fleck.github.io/testthis/index.html)
 #'
 #' @name testthis
 #' @import assertthat
@@ -53,7 +54,7 @@
 #'
 #' * `@testing <functionname>`:  mark `functionname` as tested.
 #' Should usually go next the associated `test_that()` call. This is used by
-#' `get_test_coverage()`.
+#' `test_coverage()`.
 #'
 #'
 #' @seealso [usethis::edit_r_profile()]
@@ -84,8 +85,6 @@ if(getRversion() >= "2.15.1")  utils::globalVariables(c("."))
   toset <- !(names(op.testthis) %in% names(op))
   if(any(toset)) options(op.testthis[toset])
 
-
-
   if (requireNamespace("crayon", quietly = TRUE) && crayon::has_color()){
 
     style_error   <- crayon::make_style("#BB3333", colors = 256)
@@ -111,7 +110,5 @@ if(getRversion() >= "2.15.1")  utils::globalVariables(c("."))
   assign("style_accent", style_accent, envir = parent.env(environment()))
   assign("col_nchar", col_nchar, envir = parent.env(environment()))
 
-
-
   invisible()
 }

R/use_test_subdir.R

@@ -8,15 +8,15 @@
 #'
 #' @inheritSection test_subdir Test subdirectory presets
 #'
-#' @param path Character scalar. Will be processed with [base::make.names()] to
+#' @param path `character` scalar. Will be processed with [base::make.names()] to
 #'   make a syntactically valid name.
-#' @param make_tester Logical or character scalar. Create an R script with a
+#' @param make_tester `logical` or `character` scalar. Create an R script with a
 #'   test helper function. If `TRUE` an R script file will be placed into the
 #'   \file{R/} directory of the current package, containing a function definition
 #'   for running the tests in `path`. The file will be named
 #'   \file{testthis-testers.R}, but you can specify  your own name by
-#'   passing a character scalar to make_tester. See [use_tester()] for details.
-#' @param ignore_tester Logical. Add \file{tester} file to \file{.Rbuildignore}?
+#'   passing a character scalar to `make_tester()`. See [use_tester()] for details.
+#' @param ignore_tester `logical` scalar`. Add \file{tester} file to \file{.Rbuildignore}?
 #' @seealso [`test_subdir()`]
 #' @family infrastructure
 #'
@@ -40,9 +40,8 @@ use_test_subdir <- function(
 ){
   # Preconditions
   assert_that(
-    is.scalar(path) && is.character(path),
-    is.scalar(make_tester),
-    is.scalar(is.logical(make_tester) || is.character(make_tester))
+    is_scalar_character(path),
+    is_scalar_bool(make_tester) || is_scalar_character(make_tester)
   )
 
   # Process arguments
@@ -73,10 +72,11 @@ use_test_subdir <- function(
 #' in a predefined directory. This function powers the `make_tester` option
 #' of [use_test_subdir()] and you will likely not need to run it manually.
 #'
-#' @param path Name of the subdirectory oft \file{tests/testthat/} for which
-#'   to create a tester function.
-#' @param ignore Logical. Add `tester_path` to \file{.Rbuildignore}?
-#' @param tester_path \R script file in which to store the tester functions
+#' @param path `character` scalar. Name of the subdirectory of
+#'   \file{tests/testthat/} for which to create a tester function.
+#' @param ignore `logical` scalar. Add `tester_path` to \file{.Rbuildignore}?
+#' @param tester_path `logical` scalar. Path to the \R script file in which to
+#' store the tester functions
 #'
 #' @return `TRUE` on success (invisibly).
 #' @export
@@ -87,6 +87,11 @@ use_tester <- function(
   ignore = TRUE,
   tester_path = file.path("R", "testthis-testers.R")
 ){
+  assert_that(
+    is_scalar_bool(ignore),
+    is_scalar_character(tester_path)
+  )
+
   fname   <- file.path(usethis::proj_get(), tester_path)
   assert(
     dir.exists(dirname(fname)),

R/use_testdata.R

@@ -5,7 +5,7 @@
 #'
 #' @param ... \R objects to save to the \file{testdata} dir. If empty,
 #'   an empty directory is created.
-#' @param subdir Character scalar. Subdirectory of \file{testdata} to save
+#' @param subdir `character` scalar. Subdirectory of \file{testdata} to save
 #'   to / read from.
 #' @inheritParams base::readRDS
 #' @template overwrite
@@ -33,8 +33,9 @@ use_testdata <- function(
 ){
   # Preconditions
   assert_that(
-    is.flag(overwrite),
-    is.null(subdir) || (is.scalar(subdir) && is.character(subdir))
+    is_scalar_bool(overwrite),
+    is_scalar_bool(ignore),
+    is.null(subdir) || is_scalar_character(subdir)
   )
 
 

README.Rmd

@@ -11,15 +11,18 @@ output: github_document
 <!-- badges: end -->
 
 **testthis** makes unit testing in R more comfortable. It is designed to 
-complement the packages **testthat**, **devtools** and **usethis**. 
+complement the packages 
+[testthat](https://github.com/r-lib/testthat), 
+[devtools](https://github.com/r-lib/devtools) and 
+[usethis](https://github.com/r-lib/usethis). 
 
 
 
 ## Overview
 
-testthis provides RStudio addins for common tasks. These can be called like
-normal R function, but it is also possible to assigned to hotkeys to them in
-RStudio (*Tools/Modify Keyboard Shortcuts*).
+testthis provides RStudio addins for working with files that contain tests. 
+These can be called like normal R function, but it is also possible to 
+assigned them to hotkeys RStudio (*Tools/Modify Keyboard Shortcuts*).
 
 * `test_this()`: Reloads the package and runs tests associated with the 
   currently open R script file.
@@ -37,7 +40,7 @@ testthis also provides functions for managing tests in subdirectories of
 
 * `use_testdata()` places a single R object in the `tests/testhat/testdata` 
   directory. It is analoguous to `usethis::use_data()`, except that it saves the
-  Object in the `.rds` format, which is more appropriate for single R objects
+  object in the `.rds` format, which is more appropriate for single R objects
   than `.rda` or `.Rdata` (see `?readRDS`). 
 * `use_testdata_raw()` creates the directory `tests/testhat/testdata-raw`. Use
   this directory to put scripts that generate the data in 
@@ -46,22 +49,23 @@ testthis also provides functions for managing tests in subdirectories of
   saved with `use_testdata()`. 
 * `use_test_subdir()` and `test_subdir()` for putting/running tests in 
   subdirectories of `tests/testhat/`. These tests will *not* be run on CRAN or
-  by `devtools::test()`. This is useful for tests that require 
-  external ressources (web, databases) or take long to execute. 
+  by `devtools::test()`. This is useful for tests that take a long time to
+  execute, or that require external ressources (web, databases) that may not 
+  always be availabe. 
 
   `test_acceptance()`, `test_manual()` and
   `test_integration()` are presets to run tests in the
   `integration_tests`, `acceptance_tests` and `manual_tests` subdirectories of
   `test/testthat`.
 
 
-Testthis also provuides some primtivie code analys tools
+Testthis also provides some simple code analysis tools
 
 * `test_coverage()` lists all functions of package and shows whether they
-  are mentioned in anny `test_that(` calls's desc argument; e.g. if you have
+  are mentioned in any `test_that()` calls' desc argument; e.g. if you have
   a testfile containing `test_that("testing that function foo works", <...>)`,
-  `foo()` will show up as tested. This can function as a simple todo list for
-  testing, but does not replace a proper test coverage analyzer like
+  `foo()` will show up marked as tested. This can be used as a simple todo list 
+  for testing, but does not replace a proper test coverage analyzer like
   [covr](https://github.com/r-lib/covr).
 * `test_index()` produces an index of all `test_that()` calls. Supports RStudio
   Markers when run interactively from within RStudio.