get_data() -> samples()

and add default implementation samples(::SemObserved)

Author: alyst

src/StructuralEquationModels.jl

@@ -40,6 +40,7 @@ include("frontend/fit/summary.jl")
 # pretty printing
 include("frontend/pretty_printing.jl")
 # observed
+include("observed/abstract.jl")
 include("observed/covariance.jl")
 include("observed/data.jl")
 include("observed/missing.jl")

src/frontend/fit/standard_errors/bootstrap.jl

@@ -25,7 +25,7 @@ function se_bootstrap(
     end
 
     if isnothing(data)
-        data = get_data(observed(model(semfit)))
+        data = samples(observed(model(semfit)))
     end
 
     data = prepare_data_bootstrap(data)

src/observed/abstract.jl

@@ -0,0 +1,10 @@
+"""
+    samples(observed::SemObservedData)
+
+Gets the matrix of observed data samples.
+Rows are samples, columns are observed variables.
+
+## See Also
+[`nsamples`](@ref), [`observed_vars`](@ref).
+"""
+samples(observed::SemObserved) = observed.data

src/observed/data.jl

@@ -21,7 +21,7 @@ For observed data without missings.
 - `n_obs(::SemObservedData)` -> number of observed data points
 - `n_man(::SemObservedData)` -> number of manifest variables
 
-- `get_data(::SemObservedData)` -> observed data
+- `samples(::SemObservedData)` -> observed data
 - `obs_cov(::SemObservedData)` -> observed.obs_cov
 - `obs_mean(::SemObservedData)` -> observed.obs_mean
 - `data_rowwise(::SemObservedData)` -> observed data, stored as vectors per observation
@@ -124,7 +124,6 @@ n_man(observed::SemObservedData) = observed.n_man
 ### additional methods
 ############################################################################################
 
-get_data(observed::SemObservedData) = observed.data
 obs_cov(observed::SemObservedData) = observed.obs_cov
 obs_mean(observed::SemObservedData) = observed.obs_mean
 data_rowwise(observed::SemObservedData) = observed.data_rowwise

src/observed/missing.jl

@@ -30,7 +30,7 @@ For observed data with missing values.
 - `n_obs(::SemObservedMissing)` -> number of observed data points
 - `n_man(::SemObservedMissing)` -> number of manifest variables
 
-- `get_data(::SemObservedMissing)` -> observed data
+- `samples(::SemObservedMissing)` -> observed data
 - `data_rowwise(::SemObservedMissing)` -> observed data as vector per observation, with missing values deleted
 
 - `patterns(::SemObservedMissing)` -> indices of non-missing variables per missing patterns
@@ -211,7 +211,6 @@ n_man(observed::SemObservedMissing) = observed.n_man
 ### Additional methods
 ############################################################################################
 
-get_data(observed::SemObservedMissing) = observed.data
 patterns(observed::SemObservedMissing) = observed.patterns
 patterns_not(observed::SemObservedMissing) = observed.patterns_not
 rows(observed::SemObservedMissing) = observed.rows

test/unit_tests/data_input_formats.jl

@@ -1,5 +1,5 @@
 using StructuralEquationModels, Test, Statistics
-using StructuralEquationModels: obs_cov, obs_mean, get_data
+using StructuralEquationModels: obs_cov, obs_mean, samples
 ### model specification --------------------------------------------------------------------
 
 spec = ParameterTable(
@@ -64,8 +64,8 @@ all_equal_cov =
     (obs_cov(observed) == obs_cov(observed_matrix))
 
 all_equal_data =
-    (get_data(observed) == get_data(observed_nospec)) &
-    (get_data(observed) == get_data(observed_matrix))
+    (samples(observed) == samples(observed_nospec)) &
+    (samples(observed) == samples(observed_matrix))
 
 @testset "unit tests | SemObservedData | input formats" begin
     @test all_equal_cov
@@ -94,8 +94,8 @@ all_equal_cov_suffled =
     (obs_cov(observed) == obs_cov(observed_matrix_shuffle))
 
 all_equal_data_suffled =
-    (get_data(observed) == get_data(observed_shuffle)) &
-    (get_data(observed) == get_data(observed_matrix_shuffle))
+    (samples(observed) == samples(observed_shuffle)) &
+    (samples(observed) == samples(observed_matrix_shuffle))
 
 @testset "unit tests | SemObservedData | input formats shuffled " begin
     @test all_equal_cov_suffled
@@ -396,8 +396,8 @@ observed_matrix = SemObservedMissing(
 )
 
 all_equal_data =
-    isequal(get_data(observed), get_data(observed_nospec)) &
-    isequal(get_data(observed), get_data(observed_matrix))
+    isequal(samples(observed), samples(observed_nospec)) &
+    isequal(samples(observed), samples(observed_matrix))
 
 @testset "unit tests | SemObservedMissing | input formats" begin
     @test all_equal_data
@@ -421,8 +421,8 @@ observed_matrix_shuffle = SemObservedMissing(
 )
 
 all_equal_data_shuffled =
-    isequal(get_data(observed), get_data(observed_shuffle)) &
-    isequal(get_data(observed), get_data(observed_matrix_shuffle))
+    isequal(samples(observed), samples(observed_shuffle)) &
+    isequal(samples(observed), samples(observed_matrix_shuffle))
 
 @testset "unit tests | SemObservedMissing | input formats shuffled " begin
     @test all_equal_data_suffled