[28aa3b]: / man / downloadAndPrepareMetadata.Rd

Download this file

45 lines (40 with data), 1.2 kB

 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
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/downloadAndPrepareMetadata.R
\name{downloadAndPrepareMetadata}
\alias{downloadAndPrepareMetadata}
\title{Download GEO metadata}
\usage{
downloadAndPrepareMetadata(geo_nbr, destdir = getwd(), clean = FALSE,
verbose = TRUE)
}
\arguments{
\item{geo_nbr}{The GEO ascession number.}
\item{destdir}{The destination dir of the downloaded files.}
\item{clean}{Should the strictly unnessesary files be deleted?}
\item{verbose}{Signal the process.}
}
\value{
A \code{list} of \code{data.frame}s giving the clinical and metadata
information for the GEO dataset.
}
\description{
Function for downloading the metadata of a GEO dataset and prepare it for
analysis.
The function uses \code{getGEOSuppFiles} which downloads the data. The
function then unzips the data files in the GEO series.
}
\note{
The function will overwrite existing files in the \code{destdir}.
}
\examples{
\dontrun{
print(DLBCL_overview)
geo_nbr <- DLBCL_overview[6,1]
downloadAndPrepareMetadata(geo_nbr = geo_nbr, destdir = getwd())
}
}
\author{
Anders Ellern Bilgrau,
Steffen Falgreen Larsen
}
\keyword{internal}