catmaid_connection_setenv: Import/Export catmaid connection details to system variables...

View source: R/catmaid_connection.R

catmaid_connection_setenvR Documentation

Import/Export catmaid connection details to system variables (e.g. for tests)

Description

catmaid_connection_setenv sets environment variables based on a catmaid_connection object.

#' catmaid_connection_getenv fetches appropriately named environment variables and returns them as named character vector.

catmaid_connection_unsetenv unsets (or removes) the environment variables.

Usage

catmaid_connection_setenv(conn = NULL, ...)

catmaid_connection_getenv()

catmaid_connection_unsetenv()

Arguments

conn

A catmaid_connection object. The default value of NULL implies that the most recent cached open connection will be used.

...

additional arguments passed to catmaid_login

Details

catmaid_connection_setenv will attempt to login if this has not already been done

Value

catmaid_connection_setenv returns TRUE or FALSE depending on whether variables were set successfully. catmaid_connection_getenv returns a connection object created based on environment variables.

See Also

catmaid_login


jefferis/rcatmaid documentation built on Aug. 16, 2022, 8:52 p.m.