xyz2swc_check: xyz2swc_check: Check SWC files for standard format using...

In jefferislab/neuromorphr: R client utilities for interacting with the NeuroMorpho online repository for neuron morphology data

xyz2swc_check: Check SWC files for standard format using xyz2swc tool from NeuroMorpho.org

Description

This function sends SWC files to NeuroMorpho.org so that it can check if those SWC files are in the standard format using its xyz2swc tool. The user gets a data frame describing, for each file, any errors it contains.

Usage

xyz2swc_check(
  source_dir = NULL,
  source_file = NULL,
  neuromorpho_url = "https://neuromorpho.org",
  ...
)

Arguments

source_dir	A character string specifying the directory where the source SWC files are located.
source_file	A character string specifying the full path to a single source SWC file.
neuromorpho_url	A character string specifying the URL for the NeuroMorpho.org website (default is "https://neuromorpho.org").
...	Additional arguments.

Value

A data frame containing a description of any errors in the SWC files.

See Also

xyz2swc_convert for a function to convert into standard SWC files.

Examples

## Not run: 
# check a single file
xyz2swc_check(source_file = "path/to/file.swc")

# check all files in a directory
xyz2swc_check(source_dir = "path/to/directory/")

## End(Not run)

jefferislab/neuromorphr documentation built on April 25, 2023, 9:07 p.m.