downloadXevaSet {Xeva} | R Documentation

## Download a XevaSet object or table of available XevaSet objects

### Description

This function allows you to see the available XevaSet object and download them for use with this package. The XevaSet have been extensively curated and organised within a XevaSet class, enabling use with all the analysis tools provided in Xeva.

### Usage

    downloadXevaSet(name = NULL, saveDir = file.path(".", "XevaSet"),
      XevaSetFileName = NULL, verbose = TRUE)

### Arguments

`name` | Character string, the name of the XevaSet to download.
`saveDir` | `Character` string with the folder path where the XevaSet should be saved. Defaults to './XevaSet/'. Will create directory if it does not exist.
`XevaSetFileName` | `character` string, the file name to save the dataset under
`verbose` | `bool` Should status messages be printed during download. Defaults to TRUE.

### Value

A data.frame if name is NULL, showing all the available XevaSet objects. If name is specified, it will download the dataset from our server

### Examples

    downloadXevaSet()
    ##to download a dataset
    #library(Xeva)
    #PDXE_BRCA = downloadXevaSet(name="PDXE_BRCA", saveDir="XevaSet")

[Package Xeva version 1.2.0 Index]