Merge pull request #52 from AnotherSamWilson/MeanMatchScheme

Mean match scheme
AnotherSamWilson · Jul 29, 2022 · 8a5ecac · 8a5ecac
2 parents c41f797 + b870d8d
commit 8a5ecac
Show file tree

Hide file tree

Showing 22 changed files with 2,094 additions and 1,298 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,4 @@ dev/
 .Rproj.user
 miceforest.Rproj
 .Rhistory
+benchmarks/*
diff --git a/README.Rmd b/README.Rmd
diff --git a/README.md b/README.md
diff --git a/docs/ImputedData.rst b/docs/ImputedData.rst
@@ -0,0 +1,12 @@
+ImputedData
+===========
+
+.. currentmodule:: miceforest
+
+ImputedData
+-----------
+
+.. autosummary::
+    :toctree: id/
+
+    ImputedData
diff --git a/docs/MeanMatchScheme.rst b/docs/MeanMatchScheme.rst
@@ -0,0 +1,12 @@
+MeanMatchScheme
+================
+
+.. currentmodule:: miceforest
+
+MeanMatchScheme
+----------------
+
+.. autosummary::
+    :toctree: mms/
+
+    MeanMatchScheme
diff --git a/docs/conf.py b/docs/conf.py
@@ -72,7 +72,7 @@
 autoclass_content = 'class'
 
 # Generate autosummary pages.
-autosummary_generate = ['ImputationKernel.rst', "utils.rst"]
+autosummary_generate = ['ImputationKernel.rst', 'ImputedData.rst', "utils.rst", "MeanMatchScheme.rst"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/id/miceforest.ImputedData.rst b/docs/id/miceforest.ImputedData.rst
@@ -0,0 +1,30 @@
+miceforest.ImputedData
+======================
+
+.. currentmodule:: miceforest
+
+.. autoclass:: ImputedData
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~ImputedData.__init__
+      ~ImputedData.complete_data
+      ~ImputedData.dataset_count
+      ~ImputedData.get_correlations
+      ~ImputedData.get_means
+      ~ImputedData.iteration_count
+      ~ImputedData.plot_correlations
+      ~ImputedData.plot_imputed_distributions
+      ~ImputedData.plot_mean_convergence
+
+
+
+
+
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,4 +35,6 @@ There are very extensive `beginner <https://github.com/AnotherSamWilson/micefore
    :caption: Contents:
 
    ImputationKernel
+   ImputedData
+   MeanMatchScheme
    utils
diff --git a/docs/mms/miceforest.MeanMatchScheme.rst b/docs/mms/miceforest.MeanMatchScheme.rst
@@ -0,0 +1,29 @@
+miceforest.MeanMatchScheme
+==========================
+
+.. automodule:: miceforest.MeanMatchScheme
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MeanMatchScheme
+
+
+
+
+
+
+
+
+