diff --git a/toarstats/trends/interface.py b/toarstats/trends/interface.py new file mode 100644 index 0000000000000000000000000000000000000000..138acf1f3a4362dcc56676ce1f23a4e8544649c6 --- /dev/null +++ b/toarstats/trends/interface.py @@ -0,0 +1,22 @@ +"""This module contains the public interface for the trends subpackage. + +This module contains the following function: +calculate_quantile_regression - calculate the quantile regression +""" + +import statsmodels.formula.api as smf + + +def calculate_quantile_regression(quantiles, data): + """Calculate the quantile regression. + + This function is the public interface for the ``trends`` subpackage. + It takes all the user inputs and returns the result of the requested + quantile regression. + + :param quantiles: a single quantile or a list of quantiles to + calculate, these must be between 0 and 1 + :param data: data containing a list of date time values and + associated parameter values on which to calculate the + quantile regression + """