1% File src/library/utils/man/help.request.Rd
2% Part of the R package, https://www.R-project.org
3% Copyright 2008-2015 R Core Team
4% Distributed under GPL 2 or later
5
6\name{help.request}
7\alias{help.request}
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{
16help.request(subject = "",
17             address = "r-help@R-project.org",
18             file = "R.help.request", \dots)
19}
20\arguments{
21  \item{subject}{subject of the email.  Please do not use single quotes
22    (\kbd{'}) in the subject!  Post separate help requests for multiple
23    queries.}
24  \item{address}{recipient's email address.}
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}}.}
28}
29\details{
30  This function is not intended to replace the posting
31  guide.  Please read the guide before posting to R-help or using this
32  function (see \url{https://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,
37      stopping and opening the relevant URL if a negative response if
38      given.
39    \item checks whether the current version of \R is being used and
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
47  including current session information, and passed to
48  \code{\link{create.post}}.
49}
50\value{
51  Nothing useful.
52}
53\seealso{The posting guide (\url{https://www.r-project.org/posting-guide.html}),
54  also \code{\link{sessionInfo}()} from which you may add to the help request.
55
56  \code{\link{create.post}}.
57}
58\author{Heather Turner, based on the then current code and help page of
59  \code{\link{bug.report}()}.}
60\keyword{utilities}
61\keyword{error}
62