is_ensembl_reachable: Is the Ensembl REST API server reachable?

In ramiromagno/ensemblr: R Client for the Ensembl REST API

Is the Ensembl REST API server reachable?

Description

Check if the Ensembl server where REST API service is running is reachable. This function attempts to connect to https://rest.ensembl.org, returning TRUE on success, and FALSE otherwise. Set verbose = TRUE for a step by step description of the connection attempt.

Usage

is_ensembl_reachable(url = ensembl_server(), port = 443L, verbose = FALSE)

Arguments

url	Ensembl REST API server URL. Default is https://rest.ensembl.org. You should not need to change this parameter.
port	Network port on which to ping the server. You should not need to change this parameter.
verbose	Whether to be verbose (TRUE) or not (FALSE).

Value

A logical value: TRUE if EBI server is reachable, FALSE otherwise.

Examples

# Check if the Ensembl Server is reachable
is_ensembl_reachable() # Returns TRUE or FALSE.

# Check if the GWAS Catalog Server is reachable
# and show exactly at what step is it failing (if that is the case)
is_ensembl_reachable(verbose = TRUE)

ramiromagno/ensemblr documentation built on Sept. 5, 2024, 9:22 a.m.