API文档
generated by chatGPT
模块:mbapy.stats.analysis
该模块提供了一些统计分析的函数,用于进行假设检验和多重比较。
函数:get_interval
def get_interval(mean = None, se = None, data:Optional[Union[np.ndarray, list[int], pd.Series]] = None, confidence:float = 0.95)
功能
计算置信区间。
参数
- mean: float, 可选。均值。
- se: float, 可选。标准误差。
- data: np.ndarray, list[int], pd.Series, 可选。数据。
- confidence: float, 可选。置信水平,默认为0.95。
返回值
函数:ttest_1samp
def ttest_1samp(x1 = None, x2:float = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
单样本T检验。
参数
- x1: np.ndarray, list[int], pd.Series, 可选。样本数据。
- x2: float, 可选。样本均值。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
函数:ttest_ind
def ttest_ind(x1 = None, x2 = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
独立样本t检验。
参数
- x1: np.ndarray, list[int], pd.Series, 可选。样本1数据。
- x2: np.ndarray, list[int], pd.Series, 可选。样本2数据。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
- levene_pvalue: float。Levene检验的p值。
- ttest_result: tuple[float, float]。T检验结果。
函数:ttest_rel
def ttest_rel(x1 = None, x2 = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
配对样本T检验。
参数
- x1: np.ndarray, list[int], pd.Series, 可选。样本1数据。
- x2: np.ndarray, list[int], pd.Series, 可选。样本2数据。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
函数:mannwhitneyu
def mannwhitneyu(x1 = None, x2 = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
Mann-Whitney U检验。
参数
- x1: np.ndarray, list[int], pd.Series, 可选。样本1数据。
- x2: np.ndarray, list[int], pd.Series, 可选。样本2数据。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
函数:shapiro
def shapiro(x1 = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
Shapiro正态检验。
参数
- x1: np.ndarray, list[int], pd.Series, 可选。样本数据。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
函数:pearsonr
def pearsonr(x1 = None, x2 = None, factors:dict[str, list[str]] = None, tags:list[str] = None, df:pd.DataFrame = None, **kwargs)
功能
Pearson相关系数。
参数
- x1: np.ndarray, list[int], pd.Series, 可选。样本1数据。
- x2: np.ndarray, list[int], pd.Series, 可选。样本2数据。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tags: list[str], 可选。数据列名列表。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
函数:chi2_contingency
def chi2_contingency(observed = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
卡方检验。
参数
- observed: np.ndarray, 可选。观察频数矩阵。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
函数:fisher_exact
def fisher_exact(observed = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None, **kwargs)
功能
Fisher确切概率法。
参数
- observed: np.ndarray, 可选。观察频数矩阵。
- factors: dict[str, list[str]], 可选。数据筛选因子。
- tag: str, 可选。数据列名。
- df: pd.DataFrame, 可选。数据源。
- kwargs: dict。其他参数。
返回值
- result: tuple[float, float]。Fisher确切概率法结果。
- observed: np.ndarray。观察频数矩阵。
函数:f_oneway
def f_oneway(Xs:list = None, factors:dict[str, list[str]] = None, tag:str = None, df:pd.DataFrame = None)
功能
方差分析检验。
参数
返回值
函数:multicomp_turkeyHSD
def multicomp_turkeyHSD(factors:dict[str, list[str]], tag:str, df:pd.DataFrame, alpha:float = 0.05)
功能
使用Tukey's HSD方法进行多重比较。
参数
- factors: dict[str, list[str]]。数据筛选因子。
- tag: str。数据列名。
- df: pd.DataFrame。数据源。
- alpha: float, 可选。显著性水平,默认为0.05。
返回值
- result: statsmodels.stats.multicomp.pairwise_tukeyhsd。Tukey's HSD检验结果。
函数:turkey_to_table
def turkey_to_table(turkey_result)
功能
将Tukey's HSD检验结果转换为表格。
参数
- turkey_result: statsmodels.stats.multicomp.pairwise_tukeyhsd。Tukey's HSD检验结果。
返回值
- table: pd.DataFrame。包含以下列的DataFrame:
- 'Group 1': 第一组进行比较的组。
- 'Group 2': 第二组进行比较的组。
- 'Mean Difference': 两组之间的均值差异。
- 'p-value': 均值差异的p值。
- 'Stars': 表示均值差异显著性水平的星号数量。
- 'Reject': 表示均值差异是否拒绝原假设的布尔值。
函数:multicomp_dunnett
def multicomp_dunnett(factor:str, exp:list[str], control:str, df:pd.DataFrame, **kwargs)
功能
使用Dunnett方法进行多重比较。
参数
- factor: str。数据列名。
- exp: list[str]。实验组的子因子。
- control: str。对照组的子因子。
- df: pd.DataFrame。数据源。
- kwargs: dict。其他参数。
返回值
- result: scipy.stats.dunnett。Dunnett检验结果。
函数:multicomp_bonferroni
def multicomp_bonferroni(factors:dict[str, list[str]], tag:str, df:pd.DataFrame, alpha:float = 0.05)
功能
使用Bonferroni方法进行多重比较。
参数
- factors: dict[str, list[str]]。数据筛选因子。
- tag: str。数据列名。
- df: pd.DataFrame。数据源。
- alpha: float, 可选。显著性水平,默认为0.05。
返回值
- result: pd.DataFrame。Bonferroni方法的多重比较结果。