Switch to unified view

a b/man/downloadAndPrepareMetadata.Rd
1
% Generated by roxygen2 (4.1.1): do not edit by hand
2
% Please edit documentation in R/downloadAndPrepareMetadata.R
3
\name{downloadAndPrepareMetadata}
4
\alias{downloadAndPrepareMetadata}
5
\title{Download GEO metadata}
6
\usage{
7
downloadAndPrepareMetadata(geo_nbr, destdir = getwd(), clean = FALSE,
8
  verbose = TRUE)
9
}
10
\arguments{
11
\item{geo_nbr}{The GEO ascession number.}
12
13
\item{destdir}{The destination dir of the downloaded files.}
14
15
\item{clean}{Should the strictly unnessesary files be deleted?}
16
17
\item{verbose}{Signal the process.}
18
}
19
\value{
20
A \code{list} of \code{data.frame}s giving the clinical and metadata
21
  information for the GEO dataset.
22
}
23
\description{
24
Function for downloading the metadata of a GEO dataset and prepare it for
25
analysis.
26
The function uses \code{getGEOSuppFiles} which downloads the data. The
27
function then unzips the data files in the GEO series.
28
}
29
\note{
30
The function will overwrite existing files in the \code{destdir}.
31
}
32
\examples{
33
\dontrun{
34
print(DLBCL_overview)
35
geo_nbr <- DLBCL_overview[6,1]
36
downloadAndPrepareMetadata(geo_nbr = geo_nbr, destdir = getwd())
37
}
38
}
39
\author{
40
Anders Ellern Bilgrau,
41
  Steffen Falgreen Larsen
42
}
43
\keyword{internal}
44