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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
\name{getHdata}
\alias{getHdata}
\title{
Download and Install Datasets for \pkg{Hmisc}, \pkg{rms}, and Statistical
Modeling
}
\description{
This function downloads and makes ready to use datasets from the main
web site for the \pkg{Hmisc} and \pkg{rms} libraries. For \R, the
datasets were stored in compressed \code{\link{save}} format and
\code{getHdata} makes them available by running \code{\link{load}}
after download. For S-Plus, the datasets were stored in
\code{data.dump} format and are made available by running
\code{data.restore} after import. The dataset is run through the
\code{\link{cleanup.import}} function. Calling \code{getHdata} with no
\code{file} argument provides a character vector of names of available
datasets that are currently on the web site. For \R, \R's default
browser can optionally be launched to view \verb{html} files that were
already prepared using the \pkg{Hmisc} command
\code{html(contents())} or to view \file{.txt} or \file{.html} data
description files when available.
If \code{options(localHfiles=TRUE)} the scripts are read from local directory
\code{~/web/data/repo} instead of from the web server.
}
\usage{
getHdata(file, what = c("data", "contents", "description", "all"),
where="https://hbiostat.org/data/repo")
}
\arguments{
\item{file}{
an unquoted name of a dataset on the web site, e.g. \samp{prostate}.
Omit \code{file} to obtain a list of available datasets.
}
\item{what}{
specify \code{what="contents"} to browse the contents (metadata) for
the dataset rather than fetching the data themselves. Specify
\code{what="description"} to browse a data description file if
available. Specify \code{what="all"} to retrieve the data and see
the metadata and description.
}
\item{where}{
\acronym{URL} containing the data and metadata files
}
}
\value{
\code{getHdata()} without a \code{file} argument returns a character
vector of dataset base names. When a dataset is downloaded, the data
frame is placed in search position one and is not returned as value of
\code{getHdata}.
}
\author{Frank Harrell}
\seealso{
\code{\link{download.file}}, \code{\link{cleanup.import}},
\code{\link[foreign:read.S]{data.restore}}, \code{\link{load}}
}
\examples{
\dontrun{
getHdata() # download list of available datasets
getHdata(prostate) # downloads, load( ) or data.restore( )
# runs cleanup.import for S-Plus 6
getHdata(valung, "contents") # open browser (options(browser="whatever"))
# after downloading valung.html
# (result of html(contents()))
getHdata(support, "all") # download and open one browser window
datadensity(support)
attach(support) # make individual variables available
getHdata(plasma, "all") # download and open two browser windows
# (description file is available for plasma)
}
}
\keyword{interface}
\keyword{data}
|
