listFilters             package:biomaRt             R Documentation

_l_i_s_t_s _t_h_e _f_i_l_t_e_r_s _a_v_a_i_l_a_b_l_e _i_n _t_h_e _s_e_l_e_c_t_e_d _d_a_t_a_s_e_t

_D_e_s_c_r_i_p_t_i_o_n:

     Filters are what we use as inputs for a biomaRt query.  For
     example if we want to retrieve all entrezgene identifiers on
     chromosome X,  chromosome will be the filter with corresponding
     value X.  The listFilters functionlists the filters available in
     the selected dataset

_U_s_a_g_e:

     listFilters(mart, group, category, showGroups = FALSE, showType = FALSE)

_A_r_g_u_m_e_n_t_s:

    mart: object of class Mart created using the useMart function

   group: Show only the filters that belong to the specified filter
          group.  To get an overview of the filter groups set
          showGroups = TRUE or use the filterSummary function for a
          summary

category: Show only the filters that belong to the specified filter
          category.  To get a summary of the filter category set
          showGroups = TRUE or use the filterSummary function for a
          summary

showGroups: Boolean to indicate if one wants to display the filter
          categories and groups along with their names and descriptions

showType: Boolean to indicate if one wants to display the type of
          filter (boolean, text,list) along with their names and
          descriptions.  This is especially useful to see wether a
          filter is a boolean or not.

_A_u_t_h_o_r(_s):

     Steffen Durinck, http://www.stat.berkeley.edu/~steffen

_E_x_a_m_p_l_e_s:

     if(interactive()){
     mart = useMart("ensembl", dataset="hsapiens_gene_ensembl")
     listFilters(mart)
     }

