Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Imports:
rlang,
tibble,
tidyr
RoxygenNote: 7.3.2
RoxygenNote: 7.3.3
Suggests:
rmarkdown,
knitr,
Expand Down
37 changes: 19 additions & 18 deletions R/ModelArray_Constructor.R
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Exported Functions

### setClass of "ModelArray" #####
#' ModelArray class
#'
#' An S4 class to represent element-wise scalar data and statistics.
#'
#' @slot sources A list of source filenames
#' @slot scalars A list of element-wise scalar matrix
#' @slot results A list of statistical result matrix
#' @slot scalars A list of element-wise scalar matrices
#' @slot results A list of statistical result matrices
#' @slot path Path to the h5 file on disk
#'
#' @name ModelArray-class
#' @rdname ModelArray-class
#' @keywords internal
#' @importClassesFrom DelayedArray DelayedArray
ModelArray <- setClass(
NULL

setClass(
"ModelArray",
# contains="DelayedArray",
slots = c(
results = "list",
sources = "list",
Expand Down Expand Up @@ -43,21 +49,16 @@ ModelArraySeed <- function(filepath, name, type = NA) {



#' Load element-wise data from .h5 file as an ModelArray object
#' Construct a ModelArray object
#'
#' Load element-wise data from an .h5 file as a `ModelArray` object.
#'
#' @details:
#' Tips for debugging:
#' if you run into this error: "Error in h(simpleError(msg, call)) :
#' error in evaluating the argument 'seed' in selecting a method for
#' function 'DelayedArray': HDF5. Symbol table. Can't open object."
#' Then please check if you give correct "scalar_types" - check via
#' rhdf5::h5ls(filename_for_h5)
#' @param filepath Path to an .h5 file
#' @param scalar_types Expected scalars
#' @param analysis_names The subfolder names for results in the .h5 file.
#' If empty (default), results are not read.
#'
#' @param filepath file
#' @param scalar_types expected scalars
#' @param analysis_names the subfolder names for results in .h5 file. If empty
#' (default), results are not read.
#' @return ModelArray object
#' @return A `ModelArray` object
#' @export
#' @import methods
#' @importFrom dplyr %>%
Expand Down
21 changes: 21 additions & 0 deletions man/ModelArray-class.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 7 additions & 32 deletions man/ModelArray.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading