:py:mod:`mathdistops.qnorm`
===========================

.. py:module:: mathdistops.qnorm


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   mathdistops.qnorm.qnorm



.. py:function:: qnorm(p, mean=0, std_dev=1, graph=True)

   Quantile (Inverse Cumulative Distribution Function) of the normal distribution.

   :param p: The probability for which to find the quantile.
   :type p: float
   :param mean: The mean (average) of the normal distribution. Default is 0.
   :type mean: float, optional
   :param std_dev: The standard deviation of the normal distribution. Default is 1.
   :type std_dev: float, optional
   :param graph: Whether to plot the PDF and CDF graphs. Default is True.
   :type graph: bool, optional

   :returns: **result** --

             If `graph` is True (default), returns a tuple consisting a pandas DataFrame and a
                 layered altair Chart consisting of two graphs, CDF and PDF.
             If `graph` is False, returns a pandas DataFrame.
   :rtype: pandas.DataFrame or tuple

   :raises TypeError:: If any of the input parameters ('p', 'mean', 'std_dev') are not numerical.
   :raises ValueError:: If 'p' is not within the range [0, 1].
       If 'std_dev' is zero or negative, as standard deviation must be positive.

   .. rubric:: Example

   >>> qnorm(0.8413447460685429, mean=0, std_dev=1, graph=False)
       Quantile
   0   1.0