R/objects.R

In neuroimaginador/tidyneuro: Tidy workflows for Neuroimaging

##%######################################################%##
#                                                          #
####                      Objects                       ####
#                                                          #
##%######################################################%##

# Can manage:
#  - 3D volumes
#  - Matrices/vectors
#  - File paths
#  - A generic R object (e.g. a linear regression model)

# For each one, define functions for:
#  - Import
#  - Export
#  - Print
#  - Plot (where appropriate)
#  - Check object type
#  - Check compatibility between object types.

# When the object is a volume:
#  - Import/Export from NIfTI format.

# Placeholders for object types to be used in workflow steps:
#  - element_volume()
#  - element_matrix()
#  - element_file()
#  - element_object()

#' Volume object
#' @export
element_volume <- function() "volume"

#' Matrix object
#' @export
element_matrix <- function() "matrix"

#' File object
#' @export
element_file <- function() "file"

#' Generic object
#' @export
element_object <- function() "object"