list_cosmic {seqCAT} | R Documentation

## List COSMIC sample names

### Description

List all available samples in the COSMIC database

### Usage

    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

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

[Package seqCAT version 1.6.3 Index]