diff --git a/docs/reference/OmnipathR.html b/docs/reference/OmnipathR.html index ce8e787b..2397b509 100644 --- a/docs/reference/OmnipathR.html +++ b/docs/reference/OmnipathR.html @@ -44,7 +44,7 @@ OmnipathR - 3.11.10 + 3.11.14 + + + + + +
+
+
+ +
+

The Orthologous Matrix (OMA), a resource of orthologous relationships +between genes, doesn't provide gene symbols, the identifier preferred in +many bioinformatics pipelines. Hence this function wraps +oma_pairwise by translating the identifiers used in OMA to +gene symbols. Items that can not be translated to `id_type` (but present +in the data with their internal OMA IDs) will be removed. Then, +in this function we translate the identifiers to the desired ID type.

+
+ +
+

Usage

+
oma_pairwise_translated(
+  organism_a = "human",
+  organism_b = "mouse",
+  id_type = "uniprot",
+  oma_id_type = "uniprot_entry",
+  mappings = c("1:1", "1:m", "n:1", "n:m"),
+  only_ids = TRUE
+)
+
+ +
+

Arguments

+
organism_a
+

Name or identifier of an organism.

+ + +
organism_b
+

Name or identifier of another organism.

+ + +
id_type
+

The gene or protein identifier to use in the table. For a +list of supported ID types see `omnipath.env$id_types$oma`. These are +the identifiers that will be translated to gene symbols.

+ + +
oma_id_type
+

Character: the gene or protein identifier to be queried +from OMA. These IDs will be translated to `id_type`.

+ + +
mappings
+

Character vector: control ambiguous mappings:

  • 1:1 - unambiguous

  • +
  • 1:m - one-to-many

  • +
  • n:1 - many-to-one

  • +
  • n:m - many-to-many

  • +
+ + +
only_ids
+

Logical: include only the two identifier columns, not the +mapping type and the orthology group columns.

+ +
+
+

Value

+ + +

A data frame with orthologous gene pairs.

+
+ +
+

Examples

+
oma_pairwise_translated("human", "mouse")
+#> # A tibble: 13,006 × 2
+#>    id_organism_a id_organism_b
+#>    <chr>         <chr>        
+#>  1 P21452        P30549       
+#>  2 Q8TAD7        P0C913       
+#>  3 Q8N392        Q8K0Q5       
+#>  4 O60285        Q641K5       
+#>  5 Q07065        Q8BMK4       
+#>  6 P78371        P80314       
+#>  7 Q8N4U5        Q8K1H7       
+#>  8 Q8WU20        Q8C180       
+#>  9 O95619        Q9CR11       
+#> 10 Q9NW08        P59470       
+#> # ℹ 12,996 more rows
+
+
+
+
+ + +
+ + + +
+ + + + + + + diff --git a/docs/reference/only_from.html b/docs/reference/only_from.html index 955312d5..b73a1e01 100644 --- a/docs/reference/only_from.html +++ b/docs/reference/only_from.html @@ -16,7 +16,7 @@ OmnipathR - 3.11.13 + 3.11.14 + + + + + +
+
+
+ +
+

Make sure the resource supports the organism and it has the ID

+
+ +
+

Usage

+
organism_for(organism, resource, error = TRUE)
+
+ +
+

Arguments

+
organism
+

Character or integer: name or NCBI Taxonomy ID of the +organism.

+ + +
resource
+

Charater: name of the resource.

+ + +
error
+

Logical: raise an error if the organism is not supported in the +resource. Otherwise it only emits a warning.

+ +
+
+

Value

+ + +

Character: the ID of the organism as it is used by the resource. NA + if the organism can not be translated to the required identifier type.

+
+ +
+

Examples

+
organism_for(10116, 'chalmers-gem')
+#> [1] "Rat"
+# [1] "Rat"
+organism_for(6239, 'chalmers-gem')
+#> Error in organism_for(6239, "chalmers-gem"): Organism `6239` (common_name: `Caenorhabditis elegans (Nematode, N2)`; common_name: `Caenorhabditis elegans (Nematode, N2)`) is not supported by resource `chalmers-gem`. Supported organisms: Human, Mouse, Rat, Zebrafish, Drosophila melanogaster (Fruit fly), Caenorhabditis elegans (PRJNA13758).
+# [1] "Worm"
+# organism_for('foobar', 'chalmers-gem')
+# Error in organism_for("foobar", "chalmers-gem") :
+# Organism `foobar` (common_name: `NA`; common_name: `NA`)
+# is not supported by resource `chalmers-gem`. Supported organisms:
+# Human, Mouse, Rat, Zebrafish, Drosophila melanogaster (Fruit fly),
+# Caenorhabditis elegans (PRJNA13758).
+
+
+
+
+ + +
+ + + +
+ + + + + + + diff --git a/docs/reference/resources_in.html b/docs/reference/resources_in.html index 3e264e47..a5af1c8b 100644 --- a/docs/reference/resources_in.html +++ b/docs/reference/resources_in.html @@ -16,7 +16,7 @@ OmnipathR - 3.11.11 + 3.11.14