serve_data: Serve a local data directory for use with a browser

In JBrowseR: An R Interface to the JBrowse 2 Genome Browser

Serve a local data directory for use with a browser

Description

This is a utility function that can be used to server a local directory with data so that it can be used in the genome browser.

Usage

serve_data(path, port = 5000)

Arguments

path	The path to the directory with data to serve
port	The port to serve the directory on

Details

Note: This is intended for local development and use. For a production deployment, refer to the vignette on creating URLs for more robust options.

Value

a list containing information about the newly created HTTP server including the host, port, interval, and URL. The list also contains the stop_server() function which can be used to stop the server

Examples

## Not run: 
server <- serve_data("~/path/to/my-data")
# use server$stop_server() to stop

## End(Not run)

JBrowseR documentation built on June 8, 2023, 6:41 a.m.