HPA_data_downloader: HPA_data_downloader

Description Usage Arguments Value Examples

View source: R/HPA_data_downloader.R

Description

Used to download required data for HPAStainR

Usage

1
2
3
4
5
HPA_data_downloader(
  tissue_type = c("both", "normal", "cancer"),
  save_file = TRUE,
  save_location = ""
)

Arguments

tissue_type

A character string that determines which HPA data you want to download from the website. Has to be both' (default), 'normal', or 'cancer'.

save_file

A boolean determining if you want the HPA data downloaded permanently or temporarily. Default is TRUE, meaning the file will be saved in the given 'save_location', default being the current working directory.

save_location

A character string indicating where you want the files to be saved if you are saving them. If the file(s) already exists in that location, those will be loaded instead of redownloading the files.

Value

List of dataframes or dataframe depending on tissue_type arguement. If tissue_type == 'both' it will be a list of dataframes.

Examples

1
2
3
4
5
6
7
8
9
HPA_data <- HPA_data_downloader(tissue_type = 'both', save_file = FALSE)
## Access normal data
HPA_data$hpa_dat
## Access cancer data
HPA_data$cancer_dat


## Download only the normal tissue data
HPA_normal_data <- HPA_data_downloader('normal', save_file = FALSE)

HPAStainR documentation built on Feb. 11, 2021, 2:01 a.m.