write_suppa_table: Take a set of results from suppa and attempt to write it to a...

In elsayed-lab/hpgltools: A pile of (hopefully) useful R functions

Take a set of results from suppa and attempt to write it to a pretty xlsx file.

Description

Suppa provides a tremendous amount of output, this attempts to standardize those results and print them to an excel sheet.

Usage

write_suppa_table(
  table,
  annotations = NULL,
  by_table = "gene_name",
  by_annot = "ensembl_gene_id",
  columns = "default",
  excel = "excel/suppa_table.xlsx"
)

Arguments

table	Result table from suppa.
annotations	Set of annotation data to include with the suppa result.
by_table	Use this column to merge the annotations and data tables from the perspective of the data table.
by_annot	Use this column to merge the annotations and data tables from the perspective of the annotations.
columns	Choose a subset of columns to include, or leave the defaults.
excel	Provide an excel file to write.

Value

Data frame of the merged data.

See Also

[write_xlsx()]

Examples

 ## Not run: 
 prettier_table <- write_suppa_table(suppa_result_file,
                                     annotations = gene_info,
                                     excel = "excel/pretty_suppa_table.xlsx")

## End(Not run)

elsayed-lab/hpgltools documentation built on May 9, 2024, 5:02 a.m.