File: ask.Rd

package info (click to toggle)
gtools 3.9.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 748 kB
  • sloc: ansic: 190; makefile: 2
file content (46 lines) | stat: -rw-r--r-- 1,156 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
41
42
43
44
45
46
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ask.R
\name{ask}
\alias{ask}
\title{Display a prompt and collect the user's response}
\usage{
ask(msg = "Press <RETURN> to continue: ", con = stdin())
}
\arguments{
\item{msg}{Character vector providing the message to be displayed}

\item{con}{Character connection to query, defaults to \code{stdin()}.}
}
\value{
A character scalar containing the input provided by the user.
}
\description{
Display a prompt and collect the user's response
}
\details{
The prompt message will be displayed, and then \code{readLines} is used to
collect a single input value (possibly empty), which is then returned.

In most situations using the default \code{con=stdin()} should work
properly.  Under RStudio, it is necessary to specify
\code{con=file("stdin")} for proper operation.
}
\examples{


# use default prompt
ask()

silly <- function() {
  age <- ask("How old aroe you? ")
  age <- as.numeric(age)
  cat("In 10 years you will be", age + 10, "years old!\n")
}
}
\seealso{
\code{\link{readLines}}, \code{\link{scan}}
}
\author{
Gregory R. Warnes \email{greg@warnes.net}
}
\keyword{IO}