dbGetProteinFiltered: A bit more advanced version of 'dbGetProteinTable' which...

View source: R/proteinDatabase.R

dbGetProteinFilteredR Documentation

A bit more advanced version of dbGetProteinTable which allows for filtering (via SQL). Note that filtering raw columns (BLOB's) will not work properly

Description

A bit more advanced version of dbGetProteinTable which allows for filtering (via SQL). Note that filtering raw columns (BLOB's) will not work properly

Usage

dbGetProteinFiltered(
  db,
  columns = NA,
  masterProtein = FALSE,
  sortorder = NA,
  filtering = NA,
  SQL = FALSE
)

Arguments

db

database access 'handle'

columns

allows the selection of columns to take from the table, default = NA (all columns)

masterProtein

use the IsMasterProtein column to be zero, default == TRUE. If more advanced filtering is needed, use db_getTable() Note that if set to FALSE then no filtering is performed on the status of the IsMasterProtein column

sortorder

allows for sorting of the selected columns, default = NA, (no sorting). Other valid values are a single character string ("ASC" or "DESC") or a character vector of the same length as the columnNames vector containing a series of "ASC" or "DESC"

filtering

SQL statement to be used for filtering of the query. The IsMasterProtein column is already covered when masterProtein is set to TRUE

SQL

allows the function to return the SQL query statement in stead of a data.frame

Value

a data.frame containing requested data from the protein table or a character string specifying an SQL query


BenBruyneel/proteinDiscover documentation built on March 16, 2024, 4:36 p.m.