nibetaseries 0.6.0

什么是NiBetaSeries？

NiBetaSeries是一个兼容BIDS的应用程序，用于计算betaseries相关性。简而言之，每个试验（或事件）都会计算出一个beta系数（即参数估计），从而得到一系列beta值（“betaseries”），这些值可以跨感兴趣的区域进行相关性分析。

为什么我应该使用它？

您的任务fMRI数据中隐藏着潜在的见解。静息fMRI享有众多工具箱，可以通过一些努力应用于任务fMRI，但关注于制作betaseries的工具箱却不多。然后，betaseries可用于相关性/分类以及其他多种分析。虽然存在一些替代方案（pybetaseries和BASCO），但NiBetaSeries是唯一一个与BIDS组织的数据接口的应用程序，旨在提供类似于fMRIPrep的命令行应用程序体验。

NiBetaSeries能给我带来什么？

目前NiBetaSeries返回基于图谱中定义的每个区域的beta系列图像，以及可选的对称z变换相关矩阵。

我需要什么来运行NiBetaSeries？

NiBetaSeries接受BIDS和预处理数据作为输入，这些数据满足BIDS衍生物规范。在实践中，NiBetaSeries使用fMRIPrep的输出，这是一个优秀的BIDS兼容预处理工具。NiBetaSeries需要输入和图谱已经在相同的空间中（例如MNI空间）。有关更多详细信息，请参阅使用说明和教程（sphx_glr_auto_examples_plot_run_nibetaseries.py）

参与其中

这是一个非常年轻的项目，仍需要一些细心的呵护才能成长。这正是你的作用所在！如果你想做出贡献，请阅读我们的行为准则和贡献页面（contributing）。

谢谢！

本项目大量使用了nipype、nilearn、pybids和nistats进行开发。请查看它们的页面并支持开发者。

0.6.0（2020年4月9日）

添加了一个功能，将使我的论文工作更加容易，输出beta系列估计后的残差时间序列。此版本还包含更新链接到“新”默认travis ci .com的更改，并确保我正在使用sphinx 2.x.x，而不是新的3.x.x。

• [增强] 添加 –return-residuals (#304) @jdkent

• [维护] 更新travis徽章并固定sphinx (#305) @jdkent

0.5.0（2020年3月20日）

此版本添加了两个实验性标志：–normalize-betas和–no-signal-scaling。我对–normalize-betas与任何包含“衍生物”或“衍生物+分散”的hrf结合的行为特别不确定，因为我不知道何时将beta估计值除以beta估计值的方差以导出t统计量（即标准化beta估计值）。此版本还具有从LSA和LSS接口访问残差的功能。

另一个警告：由于我在生成所有模型时平均残差，因此LSS接口的残差并不那么有意义。该项目还不是1.x.x版本，因此请注意API的某些方面可能迅速变化。

感谢@michaelmack为我们提出新功能建议，以及@PeerHerholz的贡献！

• [增强] 添加 –normalize-betas选项 (#299) @jdkent

• [增强] 添加 –no-signal-scaling选项 (#298) @jdkent

• [增强、修复] 最佳组合时间+分散导数以进行beta估计 (#296) @jdkent

• [增强] 将残差添加到LSS/LSA接口 (#294) @jdkent

• [修复] 删除标准化参数 (#292) @jdkent

• [增强] 允许niftiimage输入 (#289) @jdkent

• 修复文档中的singularity安装说明 (#288) @PeerHerholz

0.4.3（2020年2月22日）

错误修复和增强发布。做出了快速决定，删除具有大而不稳定的beta估计值的体积。

• [修复] 允许atlas参数为None (#283) @jdkent

• [修复] 升级nipype版本 (#280) @jdkent

• [增强] 密封无效体积 (#277) @jdkent

• [增强] 允许用于混扰指定的正则表达式和推导 (#273) @jdkent

0.4.2（2020年1月23日）

错误修复和维护发布。

• [文档] 强调beta图分析 (#270) @jdkent

• [修复] 允许其他空间 (#269) @jdkent

• [修复] 更宽松的beta图生成 (#262) @jdkent

• [增强] 处理所有混扰NaN (#255) @jdkent

• [增强] 改进bids索引 (#253) @jdkent

• [修复] 允许“sub-”前缀 (#256) @jdkent

0.4.1（2019年12月16日）

错误修复和维护发布。

• [维护] 重构并增加run.py的测试 (#249) @jdkent

• [修复] 允许灵活的衍生物位置 (#247) @jdkent

• [增强] 当图像未找到时创建有用的错误信息 (#246) @jdkent

• 【维护】修复nistats依赖问题（#245）@jdkent

0.4.0（2019年10月07日）

这个月NiBetaSeries非常繁忙。我们增加了两种计算beta值的方法（LSA和FS），并且修改了LSS以考虑不同的条件。所有这些伟大的工作都归功于@tsalo。

第二个重大变化是我们读取FMRIPREP目录的方式的重构，之前我们假设fmriprep版本（< v1.2.0）的结果，但现在我们只支持fmriprep（>= v1.2.0）输出的文件。如果您有来自旧版本fmriprep的结果，请检查我们的FAQ以获取可能的解决方案。

第三个重大变化是生成引用模板，这样您可以轻松地将适当的信息填充到方法部分。再次感谢@tsalo的卓越贡献。

第四个也是最后一个重大变化（不分先后），是将beta系列图像映射直接传递到输出目录，不再需要用户拥有图集和查找表才能使用NiBetaSeries。这将使用户能够将beta系列图像映射用于他们希望进行的任何后续分析。

感谢以下提到的所有贡献者通过文档修复和其他代码更改来改进NiBetaSeries。

一个默默无闻的英雄是@PeerHerholz，他为代码审查和对NiBetaSeries未来发展的有益建议表示感谢！此外，还有@mwvoss为打开问题#123的贡献。提出一个好的问题是工作，应该得到认可，谢谢！

虽然我可能遗漏了向所有帮助过的人表示感谢，但请知道我非常感激你们的贡献，并且感谢你们在百忙之中抽出时间来帮助这个项目成长。

• 【文档】更新指令与模板清单（#242）@jdkent

• 【修复】更新code-server版本（#238）@jdkent

• 【文档】为工作流程生成可引用的模板（#205）@tsalo

• 【文档】在演示中阐明您正在去除颜色代码 #123 (#234) @ipacheco-uy

• 【文档】修复文档标题 (#235) @atrievel

• 【修复】在开发容器中添加nano (#233) @pranesh-sp

• 【文档】添加lsa部分 (#231) @jdkent

• 【文档】添加joss徽章 (#229) @zkhan12

• 【增强，文档】添加开发文档部分 (#222) @jdkent

• 【文档，修复】在参与者工作流程中添加假的img和lut (#225) @jdkent

• 【增强】实现有限BOLD响应-单独（FS）建模 (#204) @tsalo

• 【维护】对拉取请求允许更多宽容 (#223) @jdkent

• 【增强】使图集可选 (#213) @jdkent

• 【修复，文档】为变更日志添加标题 (#221) @jdkent

• 【维护】使travisci更高效 (#216) @jdkent

• 【修复】使codecov yaml有效 (#220) @jdkent

• 【修复】在readthedocs上显示binder徽章 (#219) @jdkent

• 【增强，文档】sphinx gallery binder (#217) @jdkent

• 【维护】使codecov更宽容 (#215) @jdkent

• 【修复】在collect_data中使用scope=derivatives (#212) @jdkent

• 【修复】回应建议的编辑 (#206) @jdkent

• 【增强】实现最小二乘法-全部（LSA）建模 (#202) @tsalo

• 【测试】添加更多测试 (#201) @jdkent

• 【修复，文档】将低通滤波器重命名为高通滤波器 (#198) @tsalo

• 【维护】明确设置codecov设置 (#200) @jdkent

• 【增强，修复】重构bids文件处理 (#193) @jdkent

• 【增强】在LSS模型中分离其他条件 (#191) @tsalo

0.3.2（2019年9月04日）

这个版本特别之处在于它将被发布在《开源软件杂志》（JOSS）上。其中一项条件是，论文上的作者必须是zenodo文件中唯一的作者。我将修改zenodo文件上列出的作者以适应这次发布，但我会为随后的发布添加所有贡献者。

• 【维护】修复zenodo文件

0.3.1（2019年9月04日）

安装和文档的更改，但没有功能代码更改。

• [DOC] 回复审查意见 (#185) @jdkent

• [DOC] 将每个人添加到zenodo文件中的贡献者列表中 (#188) @jdkent

• [MAINT] 更改安装方法 (#187) @jdkent

• [ENH] 添加代码服务器 (#182) @jdkent

• [MAINT] 构建标签 (#183) @jdkent

0.3.0 (2019年8月29日)

感谢 @PeerHerholz 和 @njvack 在此版本中的贡献。特别感谢 @snastase 作为一位出色的审稿人，并提高了项目整体质量。

• [ENH] 减少对分割的关注 (#179) @jdkent

• [FIX] 将“->”更改为通用线性模型描述 (#178) @jdkent

• [DOC] 添加数学内容 (#177) @jdkent

• [FIX] 从binder URL中删除 .git (#175) @jdkent

• [FIX] 将 pypiwin32 添加为条件依赖项 (#173) @jdkent

• [FIX] 添加readthedocs配置文件 (#174) @jdkent

• [DOC] 文档文本的细微更改 (#163) @snastase

• [MAINT] 修复标记/推送Docker镜像 (#160) @jdkent

• [FIX] binder ci触发器 (#159) @jdkent

• [ENH] 添加binder (#158) @jdkent

• [MAINT] 更改安装策略 (#157) @jdkent

• [DOC] 澄清文档 (#156) @jdkent

• [FIX] 命令行参数仅使用连字符 (#155) @jdkent

• [DOC] 添加nibs的具体示例 (#154) @jdkent

• [DOC] 添加参考文献 (#153) @jdkent

• [MAINT] 在circleci上构建文档 (#152) @jdkent

• [MAINT] Dockerfile的临时修复 (#150) @jdkent

• [MAINT] 需要 python3 (#147) @jdkent

• [ENH] 添加可视化 (#148) @jdkent

• [ENH] 添加Docker和Singularity支持 (#140) @PeerHerholz

• [DOC] 编辑文档 (#142) @jdkent

• [DOC] 微调README (#141) @njvack

• [WIP] JOSS论文 (#122) @jdkent

0.2.3 (2019年1月29日)

各种文档和测试更改。我们将继续使用readthedocs，而不是doctr。

• [FIX] 从文档中删除high_pass引用 (#90) @RaginSagan

• [FIX] 更新betaseries.rst (#91) @ilkayisik

• [ENH] 自动生成测试数据 (#93) @jdkent

• [FIX] 将codecov添加回测试 (#94) @jdkent

• [FIX] 重新整理依赖项 (#95) @jdkent

• [ENH] 添加示例 (#99) @jdkent

• [FIX] 第一步配置doctr (#100) @jdkent

• [FIX] 配置doctr (#101) @jdkent

• [FIX] 使用文档跟踪版本 (#102) @jdkent

• [ENH] 添加sphinx版本控制 (#104) @jdkent

• [FIX] 第一步简化示例 (#106) @jdkent

• [FIX] 将master添加回文档 (#107) @jdkent

• [MAINT] 使用readthedocs (#109) @jdkent

• [DOC] 添加明确的下载说明 (#112) @jdkent

• [FIX] 将graphviz添加为构建文档的依赖项 (#115) @jdkent

• [FIX] 删除冗余/不相关的文档构建选项 (#116) @jdkent

• [DOC] 修复文档中的链接 (#114) @PeerHerholz

• [FIX,MAINT] 删除3.4并测试添加3.7 (#121) @jdkent

• [FIX] pybids链接 (#120) @PeerHerholz

• [FIX] 语法链接 (#119) @PeerHerholz

0.2.2 (2018年11月15日)

快速修复错误，其中一项与将nipype依赖项更新到新版本（1.1.5）有关。

• [ENH] 添加nthreads选项并使multiproc成为默认选项 (#81) @jdkent

• [FIX] 在hrf_models中添加缺失的逗号 (#83) @jdkent

0.2.1 (2018年11月13日)

非常感谢神经黑客学院的所有人，他们帮助使这一切成为现实。此版本仍略显仓促，因为我正在测试制作发布的流程。

• [ENH] 添加Zenodo DOI链接 (#57) @kdestasio

• [ENH] 运行versioneer安装 (#60) @jdkent

• [FIX] 连接派生输出 (#61) @jdkent

• [FIX] 添加CODEOWNERS文件 (#63) @jdkent

• [FIX] 修复拉取请求模板 (#65) @kristianeschenburg

• [ENH] 更新CONTRIBUTING.rst (#66) @PeerHerholz

• [FIX] 忽略layout中的sourcedata和derivatives目录 (#69) @jdkent

• [DOC] 添加zenodo文件 (#70) @ctoroserey

• [FIX] 文件逻辑 (#71) @jdkent

• [FIX] 混淆去除 (#72) @jdkent

• [FIX] 查找元数据 (#74) @jdkent

• 【修复】针对实际数据集的多个修复 (#75) @jdkent

• 【增强】允许混杂变量为空 (#76) @jdkent

• 【增强】重写文档 (#77) @jdkent

• 【测试】添加更多测试 (#78) @jdkent

• 【管理】简化并创建部署 (#79) @jdkent

0.2.0 (2018年11月13日)

• 【管理】简化并创建部署 (#79)

• 【测试】添加更多测试 (#78)

• 【增强】重写文档 (#77)

• 【增强】允许混杂变量为空 (#76)

• 【修复】针对实际数据集的多个修复 (#75)

• 【修复】查找元数据 (#74)

• 【修复】混杂变量移除 (#72)

• 【进行中，修复】文件逻辑 (#71)

• 【文档】添加 zenodo 文件 (#70)

• 【修复】在布局中忽略 sourcedata 和 derivatives 目录 (#69)

• 【文档】更新 CONTRIBUTING.rst (#66)

• 【修复】修复拉取请求模板 (#65)

• 【修复】添加 CODEOWNERS 文件 (#63)

• 【修复】连接派生输出 (#61)

• 【维护】运行 versioneer 安装 (#60)

• 【修复】修复问题 #29：添加 Zenodo DOI 链接 (#57)

• 【修复】修复问题 #45：标签颜色一致 (#56)

• 【文档】修复 readme.rst 中的链接 (#55)

• 【文档】添加行为准则 (#53)

• 【文档】在 README 中添加贡献链接 (#52)

• 【文档】删除拉取请求模板中的致谢部分 (#50)

• 【测试】添加功能测试 (#49)

• 【修复】删除对 bootstrap 的引用 (#48)

• 【修复】测试删除基本 .travis.yml (#47)

• 【增强】删除数据目录 (#40)

• 【增强】添加拉取请求模板 (#41)

• 【增强】更新问题模板 (#44)

• 【文档】更新贡献指南 (#43)

• 【文档】README（有什么问题？） (#37)

• 【维护】将 jdkent 更改为 HBClab (#38)

• 【修复】通过测试 (#14)

• 【增强】改进文档 (#13)

• 【文档】添加文档 (#11)

• 【修复】添加图表 (#10)

• 【增强】重构 NiBetaSeries (#9)

• 【增强】重构 (#2)

0.1.0 (2018年6月8日)

• 首次发布在 PyPI。