File: setup_tinytest.Rd

package info (click to toggle)
r-cran-tinytest 1.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,072 kB
  • sloc: sh: 14; makefile: 2
file content (40 lines) | stat: -rw-r--r-- 1,022 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/setup.R
\name{setup_tinytest}
\alias{setup_tinytest}
\title{Add tinytest to package source directory}
\usage{
setup_tinytest(pkgdir, force = FALSE, verbose = TRUE)
}
\arguments{
\item{pkgdir}{\code{[character]} Package source directory}

\item{force}{\code{[logical]} Toggle overwrite existing files? (not folders)}

\item{verbose}{\code{[logical]} Toggle print progress}
}
\value{
\code{NULL}, invisibly.
}
\description{
Creates \code{inst/tinytest}, and an example test file in that
directory. Creates \code{tests/tinytest.R} so the package is
tested with \code{R CMD check}. Adds \code{tinytests} as a suggested
package to the \code{DESCRIPTION}.
}
\section{Note on \code{DESCRIPTION}}{


Fails when it does not exist. It is assumed that the
package is named in the \code{DESCRIPTION}.
}

\examples{
\dontrun{
# an easy way to set up a package 'haha' that passes
# R CMD check
pkgKitten::kitten("haha")
tinytest::setup_tinytest("haha")
}

}