flywire_timestamp: Find standard UTC timestamp for flywire materialisation...
In natverse/fafbseg: Support Functions for Analysis of FAFB EM Segmentation

flywire_timestamp

R Documentation

Find standard UTC timestamp for flywire materialisation version or timestamp

Description

Find standard UTC timestamp for flywire materialisation version or timestamp

Usage

flywire_timestamp(
  version = NULL,
  timestamp = NULL,
  convert = TRUE,
  datastack_name = getOption("fafbseg.cave.datastack_name", "flywire_fafb_production")
)

Arguments

`version`	Integer materialisation version. The special value of `'latest'` means the most recent materialisation according to CAVE.
`timestamp`	A timestamp to normalise into an R or Python timestamp in UTC. The special value of `'now'` means the current time in UTC.
`convert`	Whether to convert from Python to R timestamp (default: `TRUE`)
`datastack_name`	defaults to the value selected by `choose_segmentation` and to "flywire_fafb_production" when that is missing. See https://global.daf-apis.com/info/ for other options.

Details

Note that all CAVE timestamps are in UTC. When the timestamp argument is a character vector it is assumed to be in UTC regardless of any timezone specification. Unless the input character vector contains the string "UTC" then a warning will be issued.

Value

A POSIXct object or Python datetime object in the UTC timezone.

Examples


ts=flywire_timestamp(349)
ts
# As a unix timestamp (number of seconds since 00:00 on 1970-01-01)
as.numeric(ts)
tsp=flywire_timestamp(349, convert=FALSE)
# should be same as the numeric timestamp above
tsp$timestamp()

flywire_timestamp(timestamp="2022-08-28 17:04:49 UTC")

# nb this will return the current time *in UTC* regardless of your timezone
flywire_timestamp(timestamp="now")

## Not run: 
# same but gives a warning
flywire_timestamp(timestamp="2022-08-28 17:04:49")

## End(Not run)

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