listTestFiles: List available test files

Description Usage Arguments Details Value Author(s) Examples

View source: R/listTestFiles.R

Description

List all test files managed by DropletTestFiles on ExperimentHub.

Usage

1
2
3
4
5
6
7
8
listTestFiles(
  hub = ExperimentHub(),
  dataset = NULL,
  version = NULL,
  latest = TRUE
)

getTestFile(path, hub = ExperimentHub(), prefix = TRUE)

Arguments

hub

An ExperimentHub object.

dataset

String specifying the dataset to search for, e.g., "tenx-2.1.0-pbmc4k". By default, files are listed for all datasets.

version

String specifying the version of the files to search for.

latest

Logical scalar indicating whether the latest version of each file should be presented. Only used if version=NULL; if FALSE, entries are returned for all versions.

path

String containing the RDataPath of the resource of interest.

prefix

Logical scalar indicating whether path should be prefixed with "DropletTestFiles/".

Details

Versions refer to those of the DropletTestFiles package itself, and refer to the version of the package in which a particular dataset was added.

Value

A DataFrame containing information on all relevant test files (one per row). Of particular interest are the columns file.dataset, file.version and file.name, containing the dataset, version and name of each test file.

Author(s)

Aaron Lun

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Getting everything:
listTestFiles()

# Getting all files for a particular dataset.
out <- listTestFiles(dataset="tenx-3.1.0-5k_pbmc_protein_v3")
out

# Downloading a resource to a local file, using an EH number:
library(ExperimentHub)
hub <- ExperimentHub()
hub[[rownames(out)[1]]]

# Downloading the same resource using an RDataPath:
getTestFile(out$rdatapath[1], prefix=FALSE)

LTLA/DropletTestFiles documentation built on Sept. 18, 2020, 5:20 p.m.