catmaid_upload_neurons: Upload neuron(s) to CATMAID

View source: R/editcatmaid.R

catmaid_upload_neuronsR Documentation

Upload neuron(s) to CATMAID

Description

Uploads neurons to CATMAID, names them and annotates them. Please use with caution, as you could be heavily adding to a live tracing environment.

Usage

catmaid_upload_neurons(
  swc = NULL,
  name = "neuron SWC upload",
  annotations = NULL,
  include.tags = TRUE,
  include.connectors = TRUE,
  return.new.skids = FALSE,
  pid = 1,
  conn = NULL,
  max.upload = 10,
  ...
)

Arguments

swc

a neuron or neuronlist object, or (a) local file path(s) to your saved .swc file(s).

name

whatever you want to name your uploaded neurons. If a single character, then it will be added to all uploaded neurons. Else, can be a character vector the same length as swc.

annotations

a character vector of annotations, to be added to all of the uploaded neurons

include.tags

whether of not, if swc is a CATMAID neuron/neuronlist, to transfer its tags to its newly uploaded cognate

include.connectors

whether of not, if swc is a CATMAID neuron/neuronlist, to transfer its connectors to its newly uploaded cognate

return.new.skids

if TRUE, the new skids created in the CATMAID instance specified by conn, are returned

pid

project id. Defaults to 1

conn

CATMAID connection object, see ?catmaid::catmaid_login for details

max.upload

the maximum number of files that the function will allow you to upload at once

...

methods passed to catmaid::catmaid_fetch


alexanderbates/catnat documentation built on Sept. 5, 2023, 4:51 a.m.