Skip to contents

List matrices available in a JASPAR collection

Source: R/jaspar.R
rba_jaspar_collections_matrices.Rd

Using this function you can list all matrix profiles that are available in a collection from a JASPAR release.

Usage

rba_jaspar_collections_matrices(
  collection,
  release = 2024,
  only_last_version = FALSE,
  search = NULL,
  order = NULL,
  page_size = 1000,
  page = 1,
  ...
)

Arguments

collection

JASPAR Collection's name. See JASPAR Collections for information. The accepted values are: "CORE", "CNE", "PHYLOFACTS", "SPLICE", "POLII", "FAM", "PBM", "PBM_HOMEO", "PBM_HLH", and "UNVALIDATED".

release

Numeric: (default = 2024) Which JASPAR database release to use? Available options are: 2024, 2022, 2020, 2018, 2016, and 2014.

only_last_version

Logical: (default = FALSE) If TRUE, only the latest version of a matrix profile will be returned.

search

Character: A search term.

order

Character: A character string or a vector of character strings of field names that will be used to order the results.
Providing multiple field names is supported. You can alsoa use prefix "-" before a field name to indicate reverse ordering.

page_size

Numeric: (default = 1000) This resource returns paginated results. What is the maximum numbers of results that you want to retrieve per a page? Accepted values are between 1 and 1000.

page

Numeric: Which page of the results to retrieve? The accepted values depend on the page size and number of results.

...

rbioapi option(s). See rba_options's arguments manual for more information on available options.

Value

A list that contains a data frame with information of matrix profiles available in the collection.

Details

The results are paginated. You can control the page's size number with the function's arguments. Also, you can use rba_pages to automatically iterate over multiple pages.

Corresponding API Resources

"GET https://jaspar.elixir.no/api/v1/collections/{collection}/"

References

  • Rauluseviciute I, Riudavets-Puig R, Blanc-Mathieu R, Castro-Mondragon JA, Ferenc K, Kumar V, Lemma RB, Lucas J, Chèneby J, Baranasic D, Khan A, Fornes O, Gundersen S, Johansen M, Hovig E, Lenhard B, Sandelin A, Wasserman WW, Parcy F, Mathelier A JASPAR 2024: 20th anniversary of the open-access database of transcription factor binding profiles Nucleic Acids Res. in_press; doi: 10.1093/nar/gkad1059

  • Khan, A. and Mathelier, A. JASPAR RESTful API: accessing JASPAR data from any programming language. Bioinformatics, 2017, doi: 10.1093/bioinformatics/btx804

  • JASPAR API Documentation

  • Citations note on JASPAR website

See also

Other "JASPAR": rba_jaspar_collections(), rba_jaspar_matrix(), rba_jaspar_matrix_search(), rba_jaspar_matrix_versions(), rba_jaspar_releases(), rba_jaspar_sites(), rba_jaspar_species(), rba_jaspar_species_matrices(), rba_jaspar_taxons(), rba_jaspar_taxons_matrices(), rba_jaspar_tffm(), rba_jaspar_tffm_search()

Examples

# \donttest{
rba_jaspar_collections_matrices(collection = "CORE",
  release = 2024,
  page_size = 100,
  page = 2)
# }