dot-construct_api: Standardized api object constructor

.construct_apiR Documentation

Standardized api object constructor

Description

This function creates a standardized function to check if the TFregulome server is valid. If that is successful it will construct a api-object and return it. This is an internal helper function not meant to be called on its own.

Usage

.construct_api(server, TFregulome_url, local_db_path)

Arguments

server

server location from the calling function

TFregulome_url

specified url from the calling function

local_db_path

path to the local db from the calling function

Value

api_object

Examples

.construct_api(server = "ca")
.construct_api(TFregulome_url = "https://methmotif.org/")
.construct_api(local_db_path = "/opt/database/tfregulome.sqlite")


benoukraflab/TFregulomeR documentation built on April 17, 2024, 7:57 p.m.