vfbr-package: Programmatic Access to the virtualflybrain.org website

In jefferis/vfbr: R Package to Access the Virtual Fly Brain project API

Programmatic Access to the virtualflybrain.org website

Description

The Virtual Fly Brain project provides a website virtualflybrain.org containing neuroanatomical data for the fruit fly, Drosophila melanogaster, curated from published journal articles and bulk image data. This package enables queries against an experimental (as of time of writing) API.

Queries

• vfb_solr_query Allows you to query VFB's SOLR end point. This gives you programmatic access to the great majority of searches that you can perform interactively on the VFB website.

• vfb_neo4j_query Allows you to query VFB's Neo4J end point. This gives you programmatic access to many sophisticated searches based on the VFB ontology, including searches that may not be easily accessible via the website.

• vfb_synonym_query A higher level function that allows you to search for canonical terms with synonyms matching a given query.

Package Options

The following options can be set to specify default behaviour. They will be set to sensible defaults on package startup, unless you have previously set a value (e.g. in your Rprofile).

• vfbr.server URL of main VFB server

• vfbr.server.neo4j URL for Neo4J graph database queries

• vfbr.server.solr URL for SOLR queries

• vfbr.server.owl URL for OWL ontology queries

• vfbr.server.gepetto URL of VFB's gepetto server for 3D visualisation (see vfb_3dbrowser_url.)

• vfbr.server.r URL for opencpu/R queries - not for users at the moment

• vfbr.stack.gmr_url URL containing listing of registered GMR Gal4 confocal stacks. See gmr_stack_urls

• vfbr.stack.downloads Location of downloaded stacks. See download_gmr_stacks

Author(s)

Maintainer: Gregory Jefferis [e-mail] (ORCID)

References

See http://virtualflybrain.org

See Also

vfb_solr_query

Examples

# Show state of vfbr package options
options()[grep('^vfbr', names(options()))]

## Not run: 
example(vfb_solr_query)

## End(Not run)

jefferis/vfbr documentation built on Sept. 3, 2024, 4:41 p.m.