2.F: STRING & rbioapi
Moosa Rezwani
2026-10-17
Source:vignettes/rbioapi_string.Rmd
rbioapi_string.RmdIntroduction
STRING is a comprehensive database of known and predicted protein-protein associations. It integrates direct physical interactions and indirect functional associations from experimental evidence, curated databases, text mining, co-expression, and computational predictions. rbioapi provides a consistent R interface to STRING’s mapping, network, homology, annotation, and enrichment API resources.
Use rba_string_version() to check the STRING release and
stable address used by rbioapi.
The species argument
Most rbioapi STRING functions accept a species argument
containing an NCBI
Taxonomy identifier, such as 9606 for human. Supplying it is
recommended because it helps STRING resolve ambiguous identifiers.
For the network, interaction-partner, homology, PPI-enrichment,
network-image, and enrichment-image functions, species is
required when the input contains more than 10 unique IDs. Mapping,
functional-enrichment, and functional-annotation requests do not have
this local restriction. The limit is based on unique IDs rather than the
length of the original vector.
Map your IDs to STRING IDs
Although STRING recognizes a variety of identifiers, mapping them to STRING IDs before using other rbioapi STRING functions makes subsequent requests faster and less ambiguous.
## 1. Create a vector of protein identifiers
proteins <- c(
"p53", "BRCA1", "cdk2", "Q99835", "CDC42", "CDK1", "KIF23",
"PLK1", "RAC2", "RACGAP1", "RHOA", "RHOB", "PHF14", "RBM3"
)
## 2. Map the protein identifiers
proteins_mapped_df <- rba_string_map_ids(ids = proteins, species = 9606)
## 3. Use the mapped STRING IDs in the remaining examples
proteins_mapped <- proteins_mapped_df$stringIdGet interaction network of a protein set
You can retrieve interactions among the proteins in your set,
together with the scores for each STRING evidence channel. Use
required_score to set the minimum interaction score and
network_type to select functional, physical, or regulatory
associations.
See the Value section of the
rba_string_interactions_network() manual for descriptions
of the returned columns.
Regulatory requests return directed source-to-target records with
their own evidence scores, combined_score, and
sign ("pos", "neg", or
"n/a"). The request threshold uses the 0 to 1000 scale;
returned confidence scores use the 0 to 1 scale.
int_net <- rba_string_interactions_network(
ids = proteins_mapped,
species = 9606,
required_score = 500
)Instead of supplying protein identifiers, you can retrieve the
network formed by proteins annotated with a STRING functional term. In
this mode, set ids = NULL and supply both
network_term_id and species.
rba_string_functional_terms() can search for functional
terms using either an identifier or descriptive text:
tcr_terms <- rba_string_functional_terms(
term_text = "T cell receptor signaling pathway",
species = 9606
)The proteinCount column contains the complete number of
proteins annotated with each term, while preferredNames and
stringIds are returned as list-columns.
The first match for this search is GO:0050852, which
identifies the GO term “T cell receptor signaling pathway”:
term_net <- rba_string_interactions_network(
ids = NULL,
network_term_id = "GO:0050852",
species = 9606,
required_score = 900
)The ids and network_term_id input modes
cannot be combined.
To retrieve regulatory relationships or overlay them on a functional network:
int_net_regulatory <- rba_string_interactions_network(
ids = c("TP53", "MDM2", "CDKN1A"),
species = 9606,
network_type = "regulatory"
)
int_net_typed <- rba_string_interactions_network(
ids = c("TP53", "MDM2", "CDKN1A"),
species = 9606,
network_flavor = "typed"
)
## Compare functional confidence with regulation in each row's direction
int_net_typed[, c("preferredName_A", "preferredName_B",
"functional_combined_score", "regulatory_combined_score", "sign")]Typed output combines functional, physical, and regulatory scores.
Each functional pair is returned in both orientations. Physical scores
are symmetric, while regulatory scores and signs describe the direction
from stringId_A to stringId_B. Missing or
below-threshold typed scores are numeric NA. Setting
typed_physical_edges = FALSE or
typed_regulatory_edges = FALSE fills that overlay’s score
columns with NA. Typed flavor requires a functional
network.
Get interaction partners of a protein set
The previous example returned interactions among the input proteins.
To retrieve proteins that interact with one or more input proteins,
including proteins outside the input set, use
rba_string_interaction_partners():
This function also accepts regulatory and typed requests.
limit caps the number of partners per input protein, so
directed or typed output can have more rows than the specified
limit.
## This example uses one protein (CD40), but `ids` can contain multiple proteins
int_partners <- rba_string_interaction_partners(
ids = "9606.ENSP00000361359",
species = 9606,
required_score = 900
)Get network image of a protein set
STRING can render the interaction network as a static image. The
rba_string_network_image() function supports several
options for controlling the network contents and appearance; see the
function manual for details. It also supports the same
network_term_id input mode described above.
First, visualize the mapped proteins using the confidence flavor:
## Network images - Example 1:
graph_ppi1 <- rba_string_network_image(
ids = proteins_mapped,
image_format = "image",
species = 9606,
save_image = FALSE,
required_score = 500,
network_flavor = "confidence"
)
Network images - Example 1
We can add neighboring proteins and use the actions flavor:
## Network images - Example 2:
graph_ppi2 <- rba_string_network_image(
ids = proteins_mapped,
image_format = "image",
species = 9606,
save_image = FALSE,
required_score = 500,
add_color_nodes = 5,
add_white_nodes = 5,
network_flavor = "actions"
)
Network images - Example 2
Network images also support regulatory and typed networks. The following example displays functional, physical, and directed regulatory relationships, including regulatory signs:
## Network images - Example 3:
typed_image <- rba_string_network_image(
ids = c("TP53", "MDM2", "CDKN1A"),
species = 9606,
network_flavor = "typed",
typed_physical_edges = TRUE,
show_regulatory_signs = TRUE,
save_image = FALSE
)
Network images - Example 3
Alternatively, render the network for a functional term:
## Network images - Example 4:
term_image <- rba_string_network_image(
ids = NULL,
network_term_id = "GO:0050852",
species = 9606,
required_score = 900,
save_image = FALSE
)
Network images - Example 4
Enrichment analysis using STRING
STRING supports two complementary enrichment analyses: functional enrichment and protein-protein interaction enrichment. See the STRING publication for methodological details.
Functional enrichment
Functional enrichment tests the supplied protein set against annotation resources including Gene Ontology, KEGG pathways, UniProt Keywords, PubMed publications, Pfam domains, InterPro domains, and SMART domains. The results include raw p-values and false discovery rates. See the current STRING API documentation for details.
enriched <- rba_string_enrichment(
ids = proteins_mapped,
species = 9606
)By default, results are split by category into a list of data frames.
We can inspect that structure with str():
str(enriched, max.level = 1)
#> List of 16
#> $ COMPARTMENTS :'data.frame': 25 obs. of 10 variables:
#> $ Component :'data.frame': 28 obs. of 10 variables:
#> $ DISEASES :'data.frame': 15 obs. of 10 variables:
#> $ Function :'data.frame': 15 obs. of 10 variables:
#> $ Hallmark :'data.frame': 6 obs. of 10 variables:
#> $ HPO :'data.frame': 4 obs. of 10 variables:
#> $ InterPro :'data.frame': 3 obs. of 10 variables:
#> $ KEGG :'data.frame': 46 obs. of 10 variables:
#> $ Keyword :'data.frame': 8 obs. of 10 variables:
#> $ NetworkNeighborAL:'data.frame': 6 obs. of 10 variables:
#> $ PMID :'data.frame': 100 obs. of 10 variables:
#> $ Process :'data.frame': 151 obs. of 10 variables:
#> $ RCTM :'data.frame': 66 obs. of 10 variables:
#> $ SMART :'data.frame': 1 obs. of 10 variables:
#> $ TISSUES :'data.frame': 3 obs. of 10 variables:
#> $ WikiPathways :'data.frame': 52 obs. of 10 variables:Set add_scores = TRUE to include strength
(the log10 observed-to-expected gene-count ratio) and
signal (a size-aware enrichment score). The following
example filters the results and merges terms with sufficiently
overlapping input-gene sets:
enriched_filtered <- rba_string_enrichment(
ids = proteins_mapped,
species = 9606,
add_scores = TRUE,
max_fdr = 0.05,
min_gene_count = 3,
min_strength = 0.5,
min_signal = 0.5,
merge_similarity = 0.8,
split_df = FALSE
)Let us see the “KEGG” results as an example. Below, we can see which terms of the KEGG pathways database were over-represented:
Please Note: Other services supported by rbioapi also provide Over-representation analysis tools. Please see the vignette article Do with rbioapi: Over-Representation (Enrichment) Analysis in R (link to the documentation site) for an in-depth review.
Functional enrichment plot
The enrichment-figure endpoint summarizes one enrichment category as
a plot. Use rba_string_enrichment_image() to control the
category, grouping, palette, ranking variable, output format, and number
of displayed terms. This example visualizes the KEGG enrichment for the
same protein set:
## Enrichment plots - Example 1
graph_enrich <- rba_string_enrichment_image(
ids = proteins_mapped,
species = 9606,
category = "KEGG",
image_format = "image",
save_image = FALSE,
group_by_similarity = 0.6
)
Enrichment plots - Example 1
x_axis selects the displayed quantity, while
sort_by independently selects and orders terms. This
example displays Hallmark enrichment strength in a horizontal bar plot,
with terms selected and ordered by FDR:
## Enrichment plots - Example 2
graph_enrich_bar <- rba_string_enrichment_image(
ids = proteins_mapped,
species = 9606,
category = "Hallmark",
x_axis = "strength",
sort_by = "fdr",
graph_type = "barplot",
color_palette = "red_blue",
save_image = FALSE
)
Enrichment plots - Example 2
The plot accepts the same enrichment filters and
merge_similarity as the tabular endpoint.
group_by_similarity controls visual grouping separately;
omitting it uses STRING’s default of 0.8.
Protein-protein interaction enrichment
PPI enrichment tests whether the input network contains more interactions than expected for a similarly sized protein set drawn from the background proteome. It can therefore identify evidence of functional relatedness without relying on annotation enrichment.
rba_string_enrichment_ppi(
ids = proteins_mapped,
species = 9606
)
#> $number_of_nodes
#> [1] 14
#>
#> $number_of_edges
#> [1] 35
#>
#> $average_node_degree
#> [1] 5
#>
#> $local_clustering_coefficient
#> [1] 0.58
#>
#> $expected_number_of_edges
#> [1] 20
#>
#> $p_value
#> [1] 0.0017Get functional annotations
STRING maps proteins to multiple annotation resources. Use
rba_string_annotations() to retrieve all annotations
assigned to the input proteins rather than only the subset returned by
enrichment analysis. PubMed annotations are excluded by default because
they can make the response very large.
annotations <- rba_string_annotations(
ids = "9606.ENSP00000269305",
species = 9606
)
## Annotation responses can be large, so the result is not shown hereSet allow_pubmed = TRUE to include PubMed annotations
with the other categories, or set only_pubmed = TRUE to
retrieve only PubMed annotations. only_pubmed takes
precedence if both arguments are TRUE.
pubmed_annotations <- rba_string_annotations(
ids = "9606.ENSP00000269305",
species = 9606,
only_pubmed = TRUE
)See also in Functions’ manuals
Some rbioapi STRING functions were not covered in this vignette, please check their manuals:
How to cite
To cite STRING (Please see https://string-db.org/cgi/about?footer_active_subpage=references):
- Damian Szklarczyk, Katerina Nastou, Mikaela Koutrouli, Rebecca Kirsch, Farrokh Mehryary, Radja Hachilif, Dewei Hu, Matteo E Peluso, Qingyao Huang, Tao Fang, Nadezhda T Doncheva, Sampo Pyysalo, Peer Bork, Lars J Jensen, Christian von Mering, The STRING database in 2025: protein networks with directionality of regulation, Nucleic Acids Research, Volume 53, Issue D1, 6 January 2025, Pages D730–D737, https://doi.org/10.1093/nar/gkae1113
To cite rbioapi:
- Moosa Rezwani, Ali Akbar Pourfathollah, Farshid Noorbakhsh, rbioapi: user-friendly R interface to biologic web services’ API, Bioinformatics, Volume 38, Issue 10, 15 May 2022, Pages 2952–2953, https://doi.org/10.1093/bioinformatics/btac172
Session info
#> R version 4.6.1 (2026-06-24)
#> Platform: x86_64-pc-linux-gnu
#> Running under: Ubuntu 24.04.5 LTS
#>
#> Matrix products: default
#> BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
#> LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.26.so; LAPACK version 3.12.0
#>
#> locale:
#> [1] LC_CTYPE=C.UTF-8 LC_NUMERIC=C LC_TIME=C.UTF-8
#> [4] LC_COLLATE=C.UTF-8 LC_MONETARY=C.UTF-8 LC_MESSAGES=C.UTF-8
#> [7] LC_PAPER=C.UTF-8 LC_NAME=C LC_ADDRESS=C
#> [10] LC_TELEPHONE=C LC_MEASUREMENT=C.UTF-8 LC_IDENTIFICATION=C
#>
#> time zone: UTC
#> tzcode source: system (glibc)
#>
#> attached base packages:
#> [1] stats graphics grDevices utils datasets methods base
#>
#> other attached packages:
#> [1] rbioapi_0.8.3.9000
#>
#> loaded via a namespace (and not attached):
#> [1] httr_1.4.9 cli_3.6.6 knitr_1.52 rlang_1.3.0
#> [5] xfun_0.62 otel_0.2.0 png_0.1-9 textshaping_1.0.5
#> [9] jsonlite_2.0.0 DT_0.34.0 htmltools_0.5.9 ragg_1.5.2
#> [13] sass_0.4.10 rmarkdown_2.32 grid_4.6.1 crosstalk_1.2.2
#> [17] evaluate_1.0.5 jquerylib_0.1.4 fastmap_1.2.0 yaml_2.3.12
#> [21] lifecycle_1.0.5 compiler_4.6.1 fs_2.1.0 htmlwidgets_1.6.4
#> [25] systemfonts_1.3.2 digest_0.6.39 R6_2.6.1 curl_8.1.0
#> [29] magrittr_2.0.5 bslib_0.12.0 tools_4.6.1 pkgdown_2.2.1
#> [33] cachem_1.1.0 desc_1.4.3