flycircuit-package: Support functions for analysis of raw image data provided by...

flycircuit-packageR Documentation

Support functions for analysis of raw image data provided by flycircuit.tw

Description

Functions and data for spatial analysis and annotation of neurons from the 'FlyCircuit' collection available online at http://flycircuit.tw.

Additional data

You can find out more about the data processing that we carried out by visiting the companion website for the NBLAST paper https://bit.ly/flybrains. This includes detailed instructions for the associated data downloads.

Package options

flycircuit uses the following options to configure behaviour:

  • flycircuit.datadir: path to directory where downloaded data will be stored. Defaults to package's extdata folder.

  • flycircuit.dbdir: location to which dataframes caching database tables will be downloaded.

  • flycircuit.ffdir: location of ff objects used for all by all score matrices.

  • flycircuit.bigmatdir: location of big.matrix objects previously used for all by all score matrices.

  • flycircuit.scoremat: character vector naming the default regular or ff matrix object containing nblast scores. Note that although it is is permissible to set this to the actual score matrix rather than a character vector naming the matrix, this turns out to have substantial performance penalties for large matrices.

  • flycircuit.remote_overwrite: Determines how local cached versions of data available on the web are updated. When NULL (i.e. unset) the web version is checked and, if it is newer, it is donwloaded and used to overwrite the cached copy. When FALSE the exisiting local copy is used; when TRUE the remote version is always downloaded.

Author(s)

Maintainer: Gregory Jefferis jefferis@gmail.com (ORCID)

Authors:

Other contributors:

See Also

Useful links:

Examples

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


natverse/flycircuit documentation built on Jan. 26, 2023, 6:46 p.m.