File: askUserYesNo.Rd

package info (click to toggle)
r-bioc-biocbaseutils 1.8.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 196 kB
  • sloc: makefile: 2
file content (30 lines) | stat: -rw-r--r-- 732 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/askUserYesNo.R
\name{askUserYesNo}
\alias{askUserYesNo}
\title{Ask user for a yes/no response}
\usage{
askUserYesNo(prompt, interactive.only = TRUE)
}
\arguments{
\item{prompt}{\code{character()} Question form prompt to display to the user
without a question mark}

\item{interactive.only}{\code{logical(1)} If \code{TRUE}, the function will only
prompt the user when the R session is interactive. If \code{FALSE}, the
function will always prompt the user.}
}
\value{
TRUE when user replies with 'yes' to prompt, FALSE when 'no'
}
\description{
Ask user for a yes/no response
}
\examples{

askUserYesNo("Do you want to continue")

}
\author{
Martin M.
}