Diff of /R/DLBCLdata-package.R [000000] .. [28aa3b]

Switch to unified view

a b/R/DLBCLdata-package.R
1
#' \pkg{DLBCLdata}: Automated and reproducible download and preprocessing of
2
#'   DLBCL data
3
#'
4
#' @description
5
#' An R-package for reproducible and easily available gene expression profile
6
#' (GEP) datasets in  Diffuse Large B-cell Lymphoma (DLBCL).
7
#' This package automatically downloads and preproceses the microarray data
8
#' using the manufacturer's or custom Brainarray chip definition files (CDF).
9
#'
10
#' The most important user function is \code{\link{downloadAndProcessGEO}} and
11
#' the functions documented from there. For more information, read the README
12
#' file \href{https://github.com/AEBilgrau/DLBCLdata}{here at GitHub.}
13
#'
14
#' @author
15
#'   Anders Ellern Bilgrau\cr
16
#'   Steffen Falgreen Larsen
17
#' @docType package
18
#' @name DLBCLdata-package
19
#' @aliases DLBCLdata-package DLBCLdata dlbcldata dlbcl DLBCL
20
#' @examples
21
#' # Overview of the curated available data:
22
#' print(DLBCL_overview[,-6])
23
#'
24
#' # Overview of all functions in DLBCLdata
25
#' ls("package:DLBCLdata")
26
NULL
27
28
#' Overview of available DLBCL data
29
#'
30
#' A \code{data.frame} of the manually checked and curated DLBCL datasets in
31
#' the \pkg{DLBCLdata}-package.
32
#' The \code{data.frame} gives information on the GEO number, a study
33
#' acronym, the expanded acronym, the principal author, the arraytypes
34
#' present in the study, and a full citation.
35
#'
36
#' @docType data
37
#' @name DLBCL_overview
38
#' @format
39
#' A \code{data.frame} giving information about the DLBCL studies with the
40
#' following columns:\cr
41
#' \describe{
42
#'   \item{\code{GSE}}{The accession number}
43
#'   \item{\code{Study}}{A name or abbreviation of the study.}
44
#'   \item{\code{FullName}}{The full name of the study.}
45
#'   \item{\code{Author}}{The first author of the study.}
46
#'   \item{\code{ArrayTypes}}{The array type(s) used for the gene expression profiles.}
47
#'   \item{\code{Citationv}}{Citation information. Please double check the information
48
#'     if the data is used.}
49
#' }
50
#' @keywords datasets, data
51
#' @examples
52
#' print(DLBCL_overview[,-6])
53
#' #View(DLBCL_overview)
54
NULL