flywire_change_log: Summarise edits for one or more FlyWire segment ids

In natverse/fafbseg: Support Functions for Analysis of FAFB EM Segmentation

Summarise edits for one or more FlyWire segment ids

Description

Summarise edits for one or more FlyWire segment ids

Usage

flywire_change_log(
  x,
  filtered = TRUE,
  tz = "UTC",
  root_ids = TRUE,
  OmitFailures = TRUE,
  ...
)

Arguments

x	One or more flywire segment ids (character vector recommended but any format accepted by flywire_ids will work).
filtered	Whether to filter out edits unlikely to relate to the current state of the neuron (default TRUE, see details).
tz	Time zone for edit timestamps. Defaults to "UTC" i.e. Universal Time, Coordinated. Set to "" for your current timezone. See as.POSIXct for more details.
root_ids	Whether to look up the root ids before/after each change. Default TRUE. As of June 2021 root_ids are always returned, so this is a noop.
OmitFailures	Whether to omit neurons for which there is an API timeout or error. The default value (TRUE) will skip over errors, while NA) will result in a hard stop on error. See nlapply for more details.
...	Additional arguments passed to flywire_fetch

Details

When filtered=TRUE the following are removed

• edits that are outside of the given root id - meaning these edits are in the history of the cell but the affected part of the arbour was since cut off.

• edits that were since undone by an inverse operation (often temporary splits made while reviewing a neuron.)

Value

A data frame with values

• operation_id a unique id for the edit

• timestamp in POSIXct format, to the nearest ms

• user_id numeric id for the user responsible for the edit

• is_merge whether it was a merge or a split

• user_name as a string

• before_root_ids and after_root_ids as space separated strings

In addition when filtered=FALSE, in_neuron is_relevant

Examples

flywire_change_log("720575940619010932")
flywire_change_log("720575940619010932", filtered = FALSE)
# with a flywire URL
u="https://ngl.flywire.ai/?json_url=https://globalv1.flywire-daf.com/nglstate/5409525645443072"
flywire_change_log(u)

## Not run: 
# use flexible root id specification
flywire_change_log("DA2_lPN_R")

## End(Not run)

natverse/fafbseg documentation built on Nov. 11, 2024, 9:50 p.m.