list_cosmic: List COSMIC sample names

Description Usage Arguments Details Value Examples

View source: R/read_cosmic.R

Description

List all available samples in the COSMIC database

Usage

1
list_cosmic(file_path)

Arguments

file_path

The file containing COSMIC data (path).

Details

This function lists the available sample names in the provided COSMIC file (e.g. CosmicCLP_MutantExport.tsv.gz), and takes about half the time it takes to read the full file with the read_cosmic function, making it useful for just seeing if your particular sample is listed in COSMIC or not.

Value

A vector of sample names

Examples

1
2
3
4
file <- system.file("extdata",
                    "subset_CosmicCLP_MutantExport.tsv.gz",
                    package = "seqCAT")
cosmic_samples <- list_cosmic(file)

seqCAT documentation built on Nov. 8, 2020, 7:36 p.m.