Merge pull request #3 from slumnitz/classify-doc

[DOC] add all classifiers to notes in doc-string
pysal · Dec 14, 2020 · 6427ce8 · 6427ce8
2 parents 83430df + e75e407
commit 6427ce8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/mapclassify/_classify_API.py b/mapclassify/_classify_API.py
@@ -94,11 +94,10 @@ def classify(y, scheme, k=5, pct=[1,10,50,90,99,100],
             and number of observations falling in each class (.counts)
     
     Note: Supported classifiers include: quantiles, box_plot, euqal_interval,
-        fisher_jenks, headtail_breaks, jenks_caspall, jenks_caspall_forced,
-        max_p_classifier, maximum_breaks, natural_breaks, percentiles, std_mean,
-        user_defined
+        fisher_jenks, fisher_jenks_sampled, headtail_breaks, jenks_caspall,
+        jenks_caspall_sampled, jenks_caspall_forced, max_p, maximum_breaks,
+        natural_breaks, percentiles, std_mean, user_defined
 
-    
     Examples
     --------
     Imports

diff --git a/notebooks/06_api.ipynb b/notebooks/06_api.ipynb
@@ -532,10 +532,9 @@
        "        and number of observations falling in each class (.counts)\n",
        "\n",
        "Note: Supported classifiers include: quantiles, box_plot, euqal_interval,\n",
-       "    fisher_jenks, headtail_breaks, jenks_caspall, jenks_caspall_forced,\n",
-       "    max_p_classifier, maximum_breaks, natural_breaks, percentiles, std_mean,\n",
-       "    user_defined\n",
-       "\n",
+       "    fisher_jenks, fisher_jenks_sampled, headtail_breaks, jenks_caspall,\n",
+       "    jenks_caspall_sampled, jenks_caspall_forced, max_p, maximum_breaks,\n",
+       "    natural_breaks, percentiles, std_mean, user_defined\n",
        "\n",
        "Examples\n",
        "--------\n",
@@ -558,7 +557,7 @@
        "Classify values by box_plot and set hinge to 2\n",
        "\n",
        ">>> box_plot = classify(x, 'box_plot', hinge=2)\n",
-       "\u001b[0;31mFile:\u001b[0m      ~/Dropbox/p/pysal/src/subpackages/mapclassify/mapclassify/_classify_API.py\n",
+       "\u001b[0;31mFile:\u001b[0m      ~/miniconda3/envs/classify/lib/python3.7/site-packages/mapclassify/_classify_API.py\n",
        "\u001b[0;31mType:\u001b[0m      function\n"
       ]
      },
@@ -594,7 +593,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.7.4"
   }
  },
  "nbformat": 4,