{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "ppcc_plot", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._morestats:ppcc_plot" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ⛔ \nPyTorch ⛔ ⛔ \nJAX ⛔ ⛔ \nDask ⛔ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "svals", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The shape values for which " }, { "__type": "CrossRef", "__tag": 4002, "value": "ppcc", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "ppcc" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " was calculated." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ppcc", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The calculated probability plot correlation coefficient values." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Calculate and optionally plot probability plot correlation coefficient." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "x", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "a, b", "annotation": "scalar", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Lower and upper bounds of the shape parameter to use." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dist", "annotation": "str or stats.distributions instance, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Distribution or distribution function name. Objects that look enough like a stats.distributions instance (i.e. they have a " }, { "__type": "InlineCode", "__tag": 4051, "value": "ppf" }, { "__type": "Text", "__tag": 4046, "value": " method) are also accepted. The default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "'tukeylambda'" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "plot", "annotation": "object, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If given, plots PPCC against the shape parameter. " }, { "__type": "ParamRef", "__tag": 4071, "name": "plot" }, { "__type": "Text", "__tag": 4046, "value": " is an object that has to have methods \"plot\" and \"text\". The " }, { "__type": "CrossRef", "__tag": 4002, "value": "matplotlib.pyplot", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "matplotlib", "version": "*", "kind": "api", "path": "matplotlib.pyplot" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " module or a Matplotlib Axes object can be used, or a custom object with the same methods. Default is None, which means that no plot is created." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "N", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of points on the horizontal axis (equally distributed from " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "ParamRef", "__tag": 4071, "name": "b" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The probability plot correlation coefficient (PPCC) plot can be used to determine the optimal shape parameter for a one-parameter family of distributions. It cannot be used for distributions without shape parameters (like the normal distribution) or with multiple shape parameters." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default a Tukey-Lambda distribution (" }, { "__type": "InlineRole", "__tag": 4003, "value": "stats.tukeylambda", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ") is used. A Tukey-Lambda PPCC plot interpolates from long-tailed to short-tailed distributions via an approximately normal one, and is therefore particularly useful in practice." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/stats/_morestats.py", "item_line": 772, "item_type": "function", "aliases": [ "scipy.stats.ppcc_plot" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "First we generate some random data from a Weibull distribution\nwith shape parameter 2.5, and plot the histogram of the data:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import stats\nimport matplotlib.pyplot as plt\nrng = np.random.default_rng()\nc = 2.5\nx = stats.weibull_min.rvs(c, scale=4, size=2000, random_state=rng)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nTake a look at the histogram of the data.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "fig1, ax = plt.subplots(figsize=(9, 4))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax.hist(x, bins=50)\nax.set_title('Histogram of x')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "plt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-25fc430d56d77005.png" } }, { "__type": "Text", "__tag": 4046, "value": "\nNow we explore this data with a PPCC plot as well as the related\nprobability plot and Box-Cox normplot. A red line is drawn where we\nexpect the PPCC value to be maximal (at the shape parameter ``c``\nused above):\n\n" }, { "__type": "Code", "__tag": 4050, "value": "fig2 = plt.figure(figsize=(12, 4))\nax1 = fig2.add_subplot(1, 3, 1)\nax2 = fig2.add_subplot(1, 3, 2)\nax3 = fig2.add_subplot(1, 3, 3)\nres = stats.probplot(x, plot=ax1)\nres = stats.boxcox_normplot(x, -4, 4, plot=ax2)\nres = stats.ppcc_plot(x, c/2, 2*c, dist='weibull_min', plot=ax3)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax3.axvline(c, color='r')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "plt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-7f5112010103d088.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "boxcox_normplot", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._morestats:boxcox_normplot" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ppcc_max", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._morestats:ppcc_max" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "probplot", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._morestats:probplot" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "tukeylambda", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "tukeylambda" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "b", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "dist", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "tukeylambda" }, { "__type": "SigParam", "__tag": 4030, "name": "plot", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "N", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "80" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ppcc_plot" }, "references": [ "J.J. Filliben, \"The Probability Plot Correlation Coefficient Test for", "Normality\", Technometrics, Vol. 17, pp. 111-117, 1975." ], "qa": "scipy.stats._morestats:ppcc_plot", "arbitrary": [], "local_refs": [ "N", "a", "b", "dist", "plot", "ppcc", "svals", "x" ] }