| 46576 |
maechler |
1 |
% File src/library/utils/man/help.request.Rd
|
|
|
2 |
% Part of the R package, http://www.R-project.org
|
| 59039 |
ripley |
3 |
% Copyright 2008-11 R Core Team
|
| 46576 |
maechler |
4 |
% Distributed under GPL 2 or later
|
|
|
5 |
|
|
|
6 |
\name{help.request}
|
| 56186 |
murdoch |
7 |
\alias{help.request}
|
| 46576 |
maechler |
8 |
\title{Send a Post to R-help}
|
|
|
9 |
\description{
|
|
|
10 |
Prompts the user to check they have done all that is expected of them
|
|
|
11 |
before sending a post to the R-help mailing list, provides a template
|
|
|
12 |
for the post with session information included and optionally sends
|
|
|
13 |
the email (on Unix systems).
|
|
|
14 |
}
|
|
|
15 |
\usage{
|
|
|
16 |
help.request(subject = "",
|
|
|
17 |
address = "r-help@R-project.org",
|
| 54509 |
ripley |
18 |
file = "R.help.request", \dots)
|
| 46576 |
maechler |
19 |
}
|
|
|
20 |
\arguments{
|
|
|
21 |
\item{subject}{subject of the email. Please do not use single quotes
|
| 47307 |
ripley |
22 |
(\kbd{'}) in the subject! Post separate help requests for multiple
|
| 46576 |
maechler |
23 |
queries.}
|
|
|
24 |
\item{address}{recipient's email address.}
|
| 54509 |
ripley |
25 |
\item{file}{filename to use (if needed) for setting up the email.}
|
|
|
26 |
\item{\dots}{additional named arguments such as \code{method} and
|
|
|
27 |
\code{ccaddress} to pass to \code{\link{create.post}}.}
|
| 46576 |
maechler |
28 |
}
|
|
|
29 |
\details{
|
|
|
30 |
This function is not intended to replace the posting
|
| 54445 |
ripley |
31 |
guide. Please read the guide before posting to R-help or using this
|
| 46576 |
maechler |
32 |
function (see \url{http://www.r-project.org/posting-guide.html}).
|
|
|
33 |
|
|
|
34 |
The \code{help.request} function:
|
|
|
35 |
\itemize{
|
|
|
36 |
\item asks whether the user has consulted relevant resources,
|
| 54445 |
ripley |
37 |
stopping and opening the relevant URL if a negative response if
|
| 46576 |
maechler |
38 |
given.
|
| 54445 |
ripley |
39 |
\item checks whether the current version of \R is being used and
|
| 46576 |
maechler |
40 |
whether the add-on packages are up-to-date, giving the option of
|
|
|
41 |
updating where necessary.
|
|
|
42 |
\item asks whether the user has prepared appropriate (minimal,
|
|
|
43 |
reproducible, self-contained, commented) example code ready to
|
|
|
44 |
paste into the post.
|
|
|
45 |
}
|
|
|
46 |
Once this checklist has been completed a template post is prepared
|
| 54509 |
ripley |
47 |
including current session information, and passed to
|
|
|
48 |
\code{\link{create.post}}.
|
| 46576 |
maechler |
49 |
}
|
| 54509 |
ripley |
50 |
\value{
|
|
|
51 |
Nothing useful.
|
|
|
52 |
}
|
|
|
53 |
\seealso{The posting guide (\url{http://www.r-project.org/posting-guide.html}),
|
|
|
54 |
also \code{\link{sessionInfo}()} from which you may add to the help request.
|
| 61433 |
ripley |
55 |
|
| 54509 |
ripley |
56 |
\code{\link{create.post}}.
|
|
|
57 |
}
|
|
|
58 |
\author{Heather Turner, based on the then current code and help page of
|
| 46576 |
maechler |
59 |
\code{\link{bug.report}()}.}
|
|
|
60 |
\keyword{utilities}
|
|
|
61 |
\keyword{error}
|
The R Project SVN
R