在开始撰写新研究论文时简化你的工作流程

原文towardsdatascience.com/streamline-your-workflow-when-starting-a-new-research-paper-50522940b0ddhttps://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/5c26191bd4a63c4de5ee6b1dfd89ee57.png由Maksym Kaharlytskyi在Unsplash上的照片我是一位拥有超过七年公共卫生和流行病学研究经验的科研人员。每次我准备开始撰写一篇新的研究论文时我都会为这个项目创建一个文件夹并在我的工作每个部分内部创建多个文件夹以及带有特定标题的 Word 文档。我已经发表了超过 170 篇同行评审论文我必须已经重复过这个流程 200 多次。我认为是时候自动化这个流程了我将与你分享如何做到这一点在文章的结尾你会找到完整的代码。你只需要将其复制并粘贴到你的 Python 环境中然后运行。这段代码将生成create_project_structure函数。这个函数将创建一个文件夹结构和 Word 文档让你可以直接开始撰写你的研究论文。这个函数的功能是什么这个函数将在指定的路径(base_path)中生成一个文件夹这个文件夹将按照你的意愿命名(project_name)。这个函数还将创建两个 Word 文档一个用于补充材料另一个用于带有标题的手稿。create_project_structure函数需要两个输入base_path和project_name。文件夹结构是什么该函数将生成一个具有以下结构的文件夹。项目名称 (project_name)— -00.参考文献— -01.数据集— -02.脚本— -03.图表— -04.表格— -05.补充材料— -06.手稿— -07.提交最后在这些文件夹中将有一个名为_old的文件夹。这是一个个人偏好。我更喜欢将旧文件移动到_old文件夹中这样主文件夹看起来就会整洁而我也可以保留旧版本作为备份。每个文件夹的目的是什么00.参考文献: 用于保存这个项目的所有参考文献你也可以在这里存储你的EndNote文件或你使用的任何其他参考文献管理器。01.数据集: 用于保存你分析所需的所有相关数据集。你可能需要保存原始数据集、应用你的选择标准后的数据集以及带有预测的数据集。02.脚本: 用于保存你的分析代码无论是 R 脚本还是 Python Jupyter 笔记本。03.图表: 用于保存你的图表这些图表很可能是由你的脚本创建的。04.表格: 用于保存你的表格也可能是由你的脚本自动创建的。05.补充材料为了保存与你的论文一起发表的补充材料。06.稿件用于保存工作稿件。在许多流行病学和公共卫生期刊中唯一接受的格式是 Word 文档或 PDF。我们仍然使用 Word 并共享文档以收集合著者的反馈。有些人像在 Google Docs 中一样在线工作。07.投稿在这个文件夹内我将为每个我提交论文以供考虑的期刊创建一个新的文件夹。我喜欢保留每个期刊的所有提交文档。这有助于跟踪我们提交的所有期刊。创建 Word 文档函数create_project_structure还将创建两个 Word 文档。一个 Word 文档将位于06.稿件文件夹内。另一个 Word 文档将位于05.补充材料文件夹内。我们通常使用 Word 文档来编写这些部分。相反在其他研究领域他们可能会使用 LaTeX例如Overleaf。两个 Word 文档都将使用表示今天日期的后缀命名。此外位于06.稿件文件夹中的 Word 文档将创建具有一级和二级标题。这些标题代表了许多生物医学、公共卫生和流行病学期刊的标准部分。根据你的需要自由编辑标题稿件 Word 文档中的副标题位于06.稿件文件夹中的 Word 文档将包含适用于多个期刊的标准标题。这些标题可能会根据你的论文、研究领域和目标期刊而有所不同。一位数的标题为一级标题两位数的标题为二级标题。标题摘要引言方法3.1. 研究设计3.2. 数据来源3.3. 研究人群3.4. 变量3.5. 统计分析3.6. 伦理结果4.1. 研究人群描述4.2. 主要发现4.3. 补充发现讨论5.1. 主要发现5.2. 影响5.3. 优点和局限性5.4. 结论声明6.1. 致谢6.2. 贡献6.3. 资金6.4. 利益冲突6.5. 数据共享6.6. 代码共享表格图表参考文献这些标题在很大程度上与一些报告指南如STROBE一致。如何运行代码如果你正在使用 Jupyter Notebook例如使用 Virtual Studio Code你只需要在一个单元格中复制完整的代码并运行它。请确保你有必要的库。确保你有操作 Word 文档的库pip install python-docx。运行包含所有代码的单元格后你将被提示输入文件夹路径base_path和项目名称project_name。窗口顶部将激活一个字段供你输入这些信息。输入路径并按回车键。输入项目名称并按回车键。https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/190f78f79bc45b882a714558934b2757.png作者截图。这就是你需要的一切你将创建一个具有上述结构的文件夹以及两个 Word 文档。在几秒钟内你就有了一个可以快速开始撰写下一篇研究论文的环境。一旦你输入了这两项信息base_path和project_name单元格将停止运行你将看到以下输出。https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/362582dae609cc3233b889ff3f220a2c.png作者截图。为保护隐私而模糊处理如你所见在指定的路径内创建了几个文件夹我在那里创建了项目My Research Project3。下面是你需要复制粘贴的代码。importosfromdatetimeimportdatetimefromdocximportDocumentdefcreate_project_structure(base_path,project_name):# Define the main folder structuresubfolders[00.References,01.Datasets,02.Scripts,03.Figures,04.Tables,05.Supplementary Materials,06.Manuscript,07.Submissions]try:# Get current datedate_suffixdatetime.now().strftime(%Y-%m-%d)# Create the main project folderproject_pathos.path.join(base_path,project_name)os.makedirs(project_path,exist_okTrue)print(fCreated main folder:{project_path})# Create subfolders and the _old folder within eachforfolderinsubfolders:subfolder_pathos.path.join(project_path,folder)os.makedirs(subfolder_path,exist_okTrue)print(fCreated subfolder:{subfolder_path})old_folder_pathos.path.join(subfolder_path,_old)os.makedirs(old_folder_path,exist_okTrue)print(fCreated _old folder:{old_folder_path})# Create the Manuscript Word documentmanuscript_pathos.path.join(project_path,06.Manuscript)manuscript_filenamefManuscript_{date_suffix}.docxmanuscript_fileos.path.join(manuscript_path,manuscript_filename)create_manuscript(manuscript_file)print(fCreated manuscript file:{manuscript_file})# Create the Supplementary Materials Word documentsupplementary_pathos.path.join(project_path,05.Supplementary Materials)supplementary_filenamefSupplementary_Materials_{date_suffix}.docxsupplementary_fileos.path.join(supplementary_path,supplementary_filename)create_blank_document(supplementary_file)print(fCreated supplementary materials file:{supplementary_file})print(Project structure created successfully!)exceptExceptionase:print(fAn error occurred:{e})defcreate_manuscript(file_path):Creates a manuscript Word document with the specified structure.documentDocument()# Level 1 and Level 2 headingsheadings[0\. Title,1\. Abstract,2\. Introduction,3\. Methods,3.1\. Study design,3.2\. Data sources,3.3\. Study population,3.4\. Variables,3.5\. Statistical Analysis,3.6\. Ethics,4\. Results,4.1\. Description of study population,4.2\. Main findings,4.3\. Complementary findings,5\. Discussion,5.1\. Main findings,5.2\. Implications,5.3\. Strengths and limitations,5.4\. Conclusions,6\. Disclosures,6.1\. Acknowledgements,6.2\. Contributions,6.3\. Funding,6.4\. Conflict of interest,6.5\. Data sharing,6.6\. Code sharing,7\. Tables,8\. Figures,9\. References]forheadinginheadings:if.inheadingandheading[2].isdigit():# Check for level 2 headingsdocument.add_heading(heading,level2)else:document.add_heading(heading,level1)document.save(file_path)defcreate_blank_document(file_path):Creates a blank Word document.documentDocument()document.save(file_path)# Example usageif__name____main__:user_pathinput(Enter the base path for the project: )project_nameinput(Enter the name of the project folder: )create_project_structure(user_path,project_name)如果你觉得这段代码有用请与你的朋友和同事分享。同时用点赞的方式支持这个故事并随时通过LinkedIn与我联系。请随意修改这段代码以适应其他类型的期刊或研究领域或者将其变成免费软件