File: browseRsp.Rd

package info (click to toggle)
r-cran-r.rsp 0.45.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,568 kB
  • sloc: javascript: 612; tcl: 304; sh: 18; makefile: 16
file content (58 lines) | stat: -rw-r--r-- 2,010 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
47
48
49
50
51
52
53
54
55
56
57
58
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  browseRsp.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{browseRsp}
\alias{browseRsp.default}
\alias{browseRsp}
\alias{browseRsp.Package}

\title{Starts the internal web browser and opens the URL in the default web browser}

\description{
 Starts the internal web browser and opens the URL in the default web browser.
 From this page you access not only help pages and demos on how to use
 RSP, but also other package RSP pages.
}

\usage{
\method{browseRsp}{default}(url=paste(urlRoot, path, sep = "/"), urlRoot=sprintf("http://\%s:\%d",
  host, port), host="127.0.0.1", port=8074L, path="", start=TRUE, stop=FALSE, ...)
}

\arguments{
  \item{url}{A \code{\link[base]{character}} string for the URL to be viewed.
    By default the URL is constructed from the \code{urlRoot} and
    the \code{path} parameters.
  }
  \item{urlRoot}{A \code{\link[base]{character}} string specifying the URL root.  By default
    the URL is constructed from the \code{host} and the \code{port}.}
  \item{host}{An optional \code{\link[base]{character}} string for the host of the URL.}
  \item{port}{An optional \code{\link[base]{integer}} for the port of the URL.}
  \item{path}{An optional \code{\link[base]{character}} string for the context path of the URL.}
  \item{start}{If \code{\link[base:logical]{TRUE}}, the internal \R web server is started if not
    already started, otherwise not.}
  \item{stop}{If \code{\link[base:logical]{TRUE}}, the internal \R web server is stopped, if started.}
  \item{...}{Additional arguments passed to \code{\link[utils]{browseURL}}.}
}

\value{
  Returns (invisibly) the URL.
}

\author{Henrik Bengtsson}

\seealso{
  Internally, \code{\link[utils]{browseURL}} is used to launch the browser.
}




\keyword{file}
\keyword{IO}
\keyword{internal}