Built site for ModelArray@0.1.5: fdf1c09

Author: araikes

llms.txt

@@ -124,7 +124,7 @@ If you use ModelArray, please cite:
 ## All functions
 
 - [`ModelArray()`](https://pennlinc.github.io/ModelArray/reference/ModelArray.md)
-  : An S4 class to represent element-wise scalar data and statistics.
+  : Construct a ModelArray object
 - [`ModelArray.gam()`](https://pennlinc.github.io/ModelArray/reference/ModelArray.gam.md)
   : Run GAM for element-wise data
 - [`ModelArray.lm()`](https://pennlinc.github.io/ModelArray/reference/ModelArray.lm.md)

pkgdown.yml

@@ -12,7 +12,7 @@ articles:
   installations: installations.html
   modelling: modelling.html
   walkthrough: walkthrough.html
-last_built: 2026-03-27T19:32Z
+last_built: 2026-03-27T20:23Z
 urls:
   reference: https://pennlinc.github.io/ModelArray/reference
   article: https://pennlinc.github.io/ModelArray/articles

reference/ModelArray-class.html

@@ -0,0 +1,21 @@
+# ModelArray class
+
+An S4 class to represent element-wise scalar data and statistics.
+
+## Slots
+
+- `sources`:
+
+  A list of source filenames
+
+- `scalars`:
+
+  A list of element-wise scalar matrices
+
+- `results`:
+
+  A list of statistical result matrices
+
+- `path`:
+
+  Path to the h5 file on disk

reference/ModelArray-class.md

@@ -1,58 +1,28 @@
-# An S4 class to represent element-wise scalar data and statistics.
+# Construct a ModelArray object
 
-An S4 class to represent element-wise scalar data and statistics.
-
-Load element-wise data from .h5 file as an ModelArray object
+Load element-wise data from an .h5 file as a \`ModelArray\` object.
 
 ## Usage
 
 ``` r
-ModelArray(filepath, scalar_types = c("FD"), analysis_names = character(0))
-
 ModelArray(filepath, scalar_types = c("FD"), analysis_names = character(0))
 ```
 
 ## Arguments
 
 - filepath:
 
-  file
+  Path to an .h5 file
 
 - scalar_types:
 
-  expected scalars
+  Expected scalars
 
 - analysis_names:
 
-  the subfolder names for results in .h5 file. If empty (default),
+  The subfolder names for results in the .h5 file. If empty (default),
   results are not read.
 
 ## Value
 
-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)
-
-## Slots
-
-- `sources`:
-
-  A list of source filenames
-
-- `scalars`:
-
-  A list of element-wise scalar matrix
-
-- `results`:
-
-  A list of statistical result matrix
-
-- `path`:
-
-  Path to the h5 file on disk
+A \`ModelArray\` object

reference/ModelArray.html

@@ -3,7 +3,7 @@
 ## All functions
 
 - [`ModelArray()`](https://pennlinc.github.io/ModelArray/reference/ModelArray.md)
-  : An S4 class to represent element-wise scalar data and statistics.
+  : Construct a ModelArray object
 - [`ModelArray.gam()`](https://pennlinc.github.io/ModelArray/reference/ModelArray.gam.md)
   : Run GAM for element-wise data
 - [`ModelArray.lm()`](https://pennlinc.github.io/ModelArray/reference/ModelArray.lm.md)

reference/ModelArray.md

@@ -16,6 +16,7 @@
 <url><loc>https://pennlinc.github.io/ModelArray/articles/walkthrough.html</loc></url>
 <url><loc>https://pennlinc.github.io/ModelArray/authors.html</loc></url>
 <url><loc>https://pennlinc.github.io/ModelArray/index.html</loc></url>
+<url><loc>https://pennlinc.github.io/ModelArray/reference/ModelArray-class.html</loc></url>
 <url><loc>https://pennlinc.github.io/ModelArray/reference/ModelArray.gam.html</loc></url>
 <url><loc>https://pennlinc.github.io/ModelArray/reference/ModelArray.html</loc></url>
 <url><loc>https://pennlinc.github.io/ModelArray/reference/ModelArray.lm.html</loc></url>