File: queryAE.Rd

package info (click to toggle)
r-bioc-arrayexpress 1.66.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 460 kB
  • sloc: makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,318 bytes parent folder | download
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
\name{queryAE}
\alias{queryAE}
\docType{data}
\title{ Query of the ArrayExpress collection in Biostudies }
\description{
  \code{queryAE} queries the ArrayExpress collection with keywords and
  give a dataframe with ArrayExpress identifiers and related
  information, as an output.
}
\usage{
queryAE(keywords = NULL, species = NULL)
}
\arguments{
  \item{keywords}{ the keyword(s) of interest. To use several words,
    they must be separated by a "+" as shown in the examples. }
  \item{species}{ the specie(s) of interest.}
}
\value{
  \code{ A dataframe with all the ArrayExpress dataset
         identifiers which correspond to the query in the first column.
         The following columns contain information about these datasets, 
         such as the number of files, the release date on the database, 
         the title, the author and content.}
}
\seealso{\code{\link[ArrayExpress]{ArrayExpress}},
  \code{\link[ArrayExpress]{getAE}}} 
\author{
  Ibrahim Emam, Audrey Kauffmann
  
  Maintainer: Jose Marugan <jcmarca@ebi.ac.uk>  
}
\examples{
## To retrieve all the identifiers of pneumonia data sets
pneumo = queryAE(keywords = "pneumonia")

## To retrieve all the identifiers of pneumonia data sets studied in human
pneumoHS = queryAE(keywords = "pneumonia", species = "homo+sapiens")
}
\keyword{datasets}