Built site for ModelArray@0.1.5: d474972

Author: araikes

llms.txt

@@ -163,8 +163,6 @@ If you use ModelArray, please cite:
   : Names of scalars in a ModelArray
 - [`scalars()`](https://pennlinc.github.io/ModelArray/reference/scalars.md)
   : Element-wise scalar data of a ModelArray object
-- [`show(`*`<ModelArray>`*`)`](https://pennlinc.github.io/ModelArray/reference/show-ModelArray-method.md)
-  : Show ModelArray object
 - [`sources()`](https://pennlinc.github.io/ModelArray/reference/sources.md)
   : Source filenames of a ModelArray object
 - [`writeResults()`](https://pennlinc.github.io/ModelArray/reference/writeResults.md)

pkgdown.yml

@@ -12,7 +12,7 @@ articles:
   installations: installations.html
   modelling: modelling.html
   walkthrough: walkthrough.html
-last_built: 2026-03-30T23:58Z
+last_built: 2026-03-31T00:13Z
 urls:
   reference: https://pennlinc.github.io/ModelArray/reference
   article: https://pennlinc.github.io/ModelArray/articles

reference/ModelArray-class.html

@@ -6,12 +6,28 @@ previously saved analysis results. The object holds references to the
 underlying HDF5 file and reads data on demand, making it suitable for
 large-scale neuroimaging datasets.
 
+Prints a summary of the ModelArray including file path, scalar
+dimensions, and any saved analysis names.
+
 ## Usage
 
 ``` r
 ModelArray(filepath, scalar_types = c("FD"), analysis_names = character(0))
+
+# S4 method for class 'ModelArray'
+show(object)
 ```
 
+## Arguments
+
+- object:
+
+  A ModelArray object.
+
+## Value
+
+Invisible `NULL`. Called for its side effect of printing to the console.
+
 ## Details
 
 ModelArray is an S4 class that represents element-wise scalar data and

reference/ModelArray-class.md

@@ -1,6 +1,8 @@
 # Names of analyses in a ModelArray
 
-Names of analyses in a ModelArray
+Returns the names of all analysis result sets currently loaded in a
+[ModelArray](https://pennlinc.github.io/ModelArray/reference/ModelArray-class.md).
+These correspond to subfolder names under `/results/` in the HDF5 file.
 
 ## Usage
 
@@ -15,8 +17,27 @@ analysisNames(x)
 
 - x:
 
-  A ModelArray object
+  A
+  [ModelArray](https://pennlinc.github.io/ModelArray/reference/ModelArray-class.md)
+  object.
 
 ## Value
 
-Character vector of analysis names
+Character vector of analysis names. Returns `character(0)` if no
+analyses have been loaded or saved.
+
+## See also
+
+[`results`](https://pennlinc.github.io/ModelArray/reference/results.md),
+[`scalarNames`](https://pennlinc.github.io/ModelArray/reference/scalarNames.md),
+[`writeResults`](https://pennlinc.github.io/ModelArray/reference/writeResults.md)
+
+## Examples
+
+``` r
+if (FALSE) { # \dontrun{
+ma <- ModelArray("data.h5", scalar_types = c("FD"),
+                 analysis_names = c("lm_age"))
+analysisNames(ma)   # "lm_age"
+} # }
+```