diff --git a/docs/404.html b/docs/404.html index 2e83ea8..134a846 100644 --- a/docs/404.html +++ b/docs/404.html @@ -33,7 +33,7 @@ OmnipathR - 3.13.11 + 3.13.15 - +
@@ -138,22 +112,22 @@

Author<

Examples

-
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 # Download post-translational modifications:
-enzsub <- import_omnipath_enzsub(resources = c("PhosphoSite", "SIGNOR"))
+enzsub <- enzyme_substrate(resources = c("PhosphoSite", "SIGNOR"))
 
 # Download protein-protein interactions
-interactions <- import_omnipath_interactions(resources = c("SignaLink3"))
+interactions <- omnipath(resources = "SignaLink3")
 
 # Convert to igraph objects:
 enzsub_g <- enzsub_graph(enzsub = enzsub)
-OPI_g <- interaction_graph(interactions = interactions )
+OPI_g <- interaction_graph(interactions = interactions)
 
 # Print some interactions:
-print_interactions(head(ptms))
+print_interactions(head(enzsub))
 
 # interactions with references:
-print_interactions(tail(ptms),writeRefs=TRUE)
+print_interactions(tail(enzsub), writeRefs = TRUE)
 
 # find interactions between kinase and substrate:
 print_interactions(dplyr::filter(ptms,enzyme_genesymbol=="MAP2K1",
@@ -172,27 +146,27 @@ 

Examples )$res, enzsub_g ) -} +} # }

-

- - + + diff --git a/docs/reference/annotated_network.html b/docs/reference/annotated_network.html index f98321d..50b44f1 100644 --- a/docs/reference/annotated_network.html +++ b/docs/reference/annotated_network.html @@ -1,5 +1,5 @@ -Network interactions with annotations — annotated_network • OmnipathRNetwork interactions with annotations — annotated_network • OmnipathR Skip to contents - -
+
+
+
+ +
+

Get the names of the enzyme-substrate relationship resources available +in https://omnipath.org/enzsub

+
+ +
+

Usage

+
enzsub_resources(dataset = NULL)
+
+ +
+

Arguments

+ + +
dataset
+

ignored for this query type

+ +
+
+

Value

+

character vector with the names of the enzyme-substrate resources

+
+
+

See also

+ +
+ +
+

Examples

+
enzsub_resources()
+#>  [1] "BEL-Large-Corpus_ProtMapper" "DEPOD"                      
+#>  [3] "HPRD"                        "HPRD_MIMP"                  
+#>  [5] "KEA"                         "Li2012"                     
+#>  [7] "MIMP"                        "NCI-PID_ProtMapper"         
+#>  [9] "PhosphoNetworks"             "PhosphoSite"                
+#> [11] "PhosphoSite_MIMP"            "PhosphoSite_ProtMapper"     
+#> [13] "ProtMapper"                  "REACH_ProtMapper"           
+#> [15] "RLIMS-P_ProtMapper"          "Reactome_ProtMapper"        
+#> [17] "SIGNOR"                      "SIGNOR_ProtMapper"          
+#> [19] "Sparser_ProtMapper"          "dbPTM"                      
+#> [21] "phosphoELM"                  "phosphoELM_MIMP"            
+
+
+
+
+ + +
+ + + +
+ + + + + + + diff --git a/docs/reference/enzyme_substrate.html b/docs/reference/enzyme_substrate.html new file mode 100644 index 0000000..31c4c06 --- /dev/null +++ b/docs/reference/enzyme_substrate.html @@ -0,0 +1,210 @@ + +Enzyme-substrate (PTM) relationships from OmniPath — enzyme_substrate • OmnipathR + Skip to contents + + +
+
+
+ +
+

Imports the enzyme-substrate (more exactly, enzyme-PTM) relationship +database from https://omnipathdb.org/enzsub. These are mostly +kinase-substrate relationships, with some acetylation and other types of +PTMs.

+
+ +
+

Usage

+
enzyme_substrate(...)
+
+ +
+

Arguments

+ + +
...
+

Arguments passed on to omnipath_query

organism
+

Character or integer: name or NCBI Taxonomy ID of the +organism. OmniPath is built of human data, and the web service provides +orthology translated interactions and enzyme-substrate relationships for +mouse and rat. For other organisms and query types, orthology +translation will be called automatically on the downloaded human data +before returning the result.

+ +
resources
+

Character vector: name of one or more resources. Restrict +the data to these resources. For a complete list of available resources, +call the `get_<query_type>_resources` functions for the query type of +interst.

+ +
genesymbols
+

Character or logical: TRUE or FALS or "yes" or "no". +Include the `genesymbols` column in the results. OmniPath uses UniProt +IDs as the primary identifiers, gene symbols are optional.

+ +
fields
+

Character vector: additional fields to include in the result. +For a list of available fields, call `query_info("interactions")`.

+ +
default_fields
+

Logical: if TRUE, the default fields will be included.

+ +
silent
+

Logical: if TRUE, no messages will be printed. By default a +summary message is printed upon successful download.

+ +
logicals
+

Character vector: fields to be cast to logical.

+ +
format
+

Character: if "json", JSON will be retrieved and processed +into a nested list; any other value will return data frame.

+ +
download_args
+

List: parameters to pass to the download function, +which is `readr::read_tsv` by default, and `jsonlite::safe_load`.

+ +
add_counts
+

Logical: if TRUE, the number of references and number of +resources for each record will be added to the result.

+ +
license
+

Character: license restrictions. By default, data from +resources allowing "academic" use is returned by OmniPath. If you use +the data for work in a company, you can provide "commercial" or +"for-profit", which will restrict the data to those records which are +supported by resources that allow for-profit use.

+ +
password
+

Character: password for the OmniPath web service. You can +provide a special password here which enables the use of `license = +"ignore"` option, completely bypassing the license filter.

+ +
exclude
+

Character vector: resource or dataset names to be excluded. +The data will be filtered after download to remove records of the +excluded datasets and resources.

+ +
strict_evidences
+

Logical: reconstruct the "sources" and "references" +columns of interaction data frames based on the "evidences" column, +strictly filtering them to the queried datasets and resources. Without +this, the "sources" and "references" fields for each record might +contain information for datasets and resources other than the queried +ones, because the downloaded records are a result of a simple filtering +of an already integrated data frame.

+ +
genesymbol_resource
+

Character: "uniprot" (default) or "ensembl". The +OmniPath web service uses the primary gene symbols as provided by +UniProt. By passing "ensembl" here, the UniProt gene symbols will be +replaced by the ones used in Ensembl. This translation results in a loss +of a few records, and multiplication of another few records due to +ambiguous translation.

+ +
cache
+

Logical: use caching, load data from and save to the. The cache +directory by default belongs to the user, located in the user's default +cache directory, and named "OmnipathR". Find out about it by +omnipath_get_cachedir. Can be changed by +omnipath_set_cachedir.

+ + +
+ +
+
+

Value

+

A data frame of enzymes and their PTM substrates.

+
+ + +
+

Examples

+
enzsub <- enzyme_substrate(
+    resources = c("PhosphoSite", "SIGNOR"),
+    organism = 9606
+)
+
+
+
+
+ + +
+ + + +
+ + + + + + + diff --git a/docs/reference/evidences.html b/docs/reference/evidences.html index ab1c198..408dcf5 100644 --- a/docs/reference/evidences.html +++ b/docs/reference/evidences.html @@ -1,8 +1,5 @@ -Show evidences for an interaction — evidences • OmnipathR Skip to contents - -