Skip to contents

Extract the main table from an ENCODE result

Source: R/accessors.R
encode_results.Rd

encode_results() returns the main table from an encodeUtils object. Use it before filtering, joining, writing a CSV, or passing rows to another function.

Usage

encode_results(x)

Arguments

x

An object returned by encode_search(), encode_list_files(), encode_select_files(), encode_download(), or encode_read().

Value

A data frame. For encode_search() and encode_list_files() output, this is the record or file table. For encode_select_files(), it is the selected file table. For encode_download(), it is the download-result table. For encode_read() collection output, it is the loaded-file metadata table.

Examples

files <- data.frame(
    file_accession = "ENCFFONE",
    file_format = "tsv",
    output_type = "gene quantifications",
    assembly = "mm10",
    status = "released",
    href = "/files/ENCFFONE/@@download/a.tsv"
)

selected <- encode_select_files(files,
    preset = "rnaseq_gene_quant",
    assembly = "mm10", quiet = TRUE
)

encode_results(selected)
#> ENCODE files
#> - files: 1
#> - experiments: 0
#> Files:
#>      file format               output assembly   status
#>  ENCFFONE    tsv gene quantifications     mm10 released