scientific-writer 2.3.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (315) hide show
  1. scientific_writer/.claude/WRITER.md +822 -0
  2. scientific_writer/.claude/settings.local.json +30 -0
  3. scientific_writer/.claude/skills/citation-management/SKILL.md +1046 -0
  4. scientific_writer/.claude/skills/citation-management/assets/bibtex_template.bib +264 -0
  5. scientific_writer/.claude/skills/citation-management/assets/citation_checklist.md +386 -0
  6. scientific_writer/.claude/skills/citation-management/references/bibtex_formatting.md +908 -0
  7. scientific_writer/.claude/skills/citation-management/references/citation_validation.md +794 -0
  8. scientific_writer/.claude/skills/citation-management/references/google_scholar_search.md +725 -0
  9. scientific_writer/.claude/skills/citation-management/references/metadata_extraction.md +870 -0
  10. scientific_writer/.claude/skills/citation-management/references/pubmed_search.md +839 -0
  11. scientific_writer/.claude/skills/citation-management/scripts/doi_to_bibtex.py +204 -0
  12. scientific_writer/.claude/skills/citation-management/scripts/extract_metadata.py +569 -0
  13. scientific_writer/.claude/skills/citation-management/scripts/format_bibtex.py +349 -0
  14. scientific_writer/.claude/skills/citation-management/scripts/search_google_scholar.py +282 -0
  15. scientific_writer/.claude/skills/citation-management/scripts/search_pubmed.py +398 -0
  16. scientific_writer/.claude/skills/citation-management/scripts/validate_citations.py +497 -0
  17. scientific_writer/.claude/skills/clinical-reports/IMPLEMENTATION_SUMMARY.md +641 -0
  18. scientific_writer/.claude/skills/clinical-reports/README.md +236 -0
  19. scientific_writer/.claude/skills/clinical-reports/SKILL.md +1088 -0
  20. scientific_writer/.claude/skills/clinical-reports/assets/case_report_template.md +352 -0
  21. scientific_writer/.claude/skills/clinical-reports/assets/clinical_trial_csr_template.md +353 -0
  22. scientific_writer/.claude/skills/clinical-reports/assets/clinical_trial_sae_template.md +359 -0
  23. scientific_writer/.claude/skills/clinical-reports/assets/consult_note_template.md +305 -0
  24. scientific_writer/.claude/skills/clinical-reports/assets/discharge_summary_template.md +453 -0
  25. scientific_writer/.claude/skills/clinical-reports/assets/hipaa_compliance_checklist.md +395 -0
  26. scientific_writer/.claude/skills/clinical-reports/assets/history_physical_template.md +305 -0
  27. scientific_writer/.claude/skills/clinical-reports/assets/lab_report_template.md +309 -0
  28. scientific_writer/.claude/skills/clinical-reports/assets/pathology_report_template.md +249 -0
  29. scientific_writer/.claude/skills/clinical-reports/assets/quality_checklist.md +338 -0
  30. scientific_writer/.claude/skills/clinical-reports/assets/radiology_report_template.md +318 -0
  31. scientific_writer/.claude/skills/clinical-reports/assets/soap_note_template.md +253 -0
  32. scientific_writer/.claude/skills/clinical-reports/references/case_report_guidelines.md +570 -0
  33. scientific_writer/.claude/skills/clinical-reports/references/clinical_trial_reporting.md +693 -0
  34. scientific_writer/.claude/skills/clinical-reports/references/data_presentation.md +530 -0
  35. scientific_writer/.claude/skills/clinical-reports/references/diagnostic_reports_standards.md +629 -0
  36. scientific_writer/.claude/skills/clinical-reports/references/medical_terminology.md +588 -0
  37. scientific_writer/.claude/skills/clinical-reports/references/patient_documentation.md +744 -0
  38. scientific_writer/.claude/skills/clinical-reports/references/peer_review_standards.md +585 -0
  39. scientific_writer/.claude/skills/clinical-reports/references/regulatory_compliance.md +577 -0
  40. scientific_writer/.claude/skills/clinical-reports/scripts/check_deidentification.py +346 -0
  41. scientific_writer/.claude/skills/clinical-reports/scripts/compliance_checker.py +78 -0
  42. scientific_writer/.claude/skills/clinical-reports/scripts/extract_clinical_data.py +102 -0
  43. scientific_writer/.claude/skills/clinical-reports/scripts/format_adverse_events.py +103 -0
  44. scientific_writer/.claude/skills/clinical-reports/scripts/generate_report_template.py +163 -0
  45. scientific_writer/.claude/skills/clinical-reports/scripts/terminology_validator.py +133 -0
  46. scientific_writer/.claude/skills/clinical-reports/scripts/validate_case_report.py +334 -0
  47. scientific_writer/.claude/skills/clinical-reports/scripts/validate_trial_report.py +89 -0
  48. scientific_writer/.claude/skills/document-skills/docx/LICENSE.txt +30 -0
  49. scientific_writer/.claude/skills/document-skills/docx/SKILL.md +197 -0
  50. scientific_writer/.claude/skills/document-skills/docx/docx-js.md +350 -0
  51. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
  52. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
  53. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
  54. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
  55. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
  56. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
  57. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
  58. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
  59. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
  60. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
  61. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
  62. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
  63. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
  64. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
  65. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
  66. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
  67. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
  68. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
  69. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
  70. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
  71. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
  72. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
  73. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
  74. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
  75. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
  76. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
  77. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
  78. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
  79. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
  80. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
  81. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
  82. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/mce/mc.xsd +75 -0
  83. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
  84. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
  85. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
  86. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
  87. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
  88. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
  89. scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
  90. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/pack.py +159 -0
  91. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/unpack.py +29 -0
  92. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validate.py +69 -0
  93. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/__init__.py +15 -0
  94. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/base.py +951 -0
  95. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/docx.py +274 -0
  96. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/pptx.py +315 -0
  97. scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/redlining.py +279 -0
  98. scientific_writer/.claude/skills/document-skills/docx/ooxml.md +610 -0
  99. scientific_writer/.claude/skills/document-skills/docx/scripts/__init__.py +1 -0
  100. scientific_writer/.claude/skills/document-skills/docx/scripts/document.py +1276 -0
  101. scientific_writer/.claude/skills/document-skills/docx/scripts/templates/comments.xml +3 -0
  102. scientific_writer/.claude/skills/document-skills/docx/scripts/templates/commentsExtended.xml +3 -0
  103. scientific_writer/.claude/skills/document-skills/docx/scripts/templates/commentsExtensible.xml +3 -0
  104. scientific_writer/.claude/skills/document-skills/docx/scripts/templates/commentsIds.xml +3 -0
  105. scientific_writer/.claude/skills/document-skills/docx/scripts/templates/people.xml +3 -0
  106. scientific_writer/.claude/skills/document-skills/docx/scripts/utilities.py +374 -0
  107. scientific_writer/.claude/skills/document-skills/pdf/LICENSE.txt +30 -0
  108. scientific_writer/.claude/skills/document-skills/pdf/SKILL.md +294 -0
  109. scientific_writer/.claude/skills/document-skills/pdf/forms.md +205 -0
  110. scientific_writer/.claude/skills/document-skills/pdf/reference.md +612 -0
  111. scientific_writer/.claude/skills/document-skills/pdf/scripts/check_bounding_boxes.py +70 -0
  112. scientific_writer/.claude/skills/document-skills/pdf/scripts/check_bounding_boxes_test.py +226 -0
  113. scientific_writer/.claude/skills/document-skills/pdf/scripts/check_fillable_fields.py +12 -0
  114. scientific_writer/.claude/skills/document-skills/pdf/scripts/convert_pdf_to_images.py +35 -0
  115. scientific_writer/.claude/skills/document-skills/pdf/scripts/create_validation_image.py +41 -0
  116. scientific_writer/.claude/skills/document-skills/pdf/scripts/extract_form_field_info.py +152 -0
  117. scientific_writer/.claude/skills/document-skills/pdf/scripts/fill_fillable_fields.py +114 -0
  118. scientific_writer/.claude/skills/document-skills/pdf/scripts/fill_pdf_form_with_annotations.py +108 -0
  119. scientific_writer/.claude/skills/document-skills/pptx/LICENSE.txt +30 -0
  120. scientific_writer/.claude/skills/document-skills/pptx/SKILL.md +484 -0
  121. scientific_writer/.claude/skills/document-skills/pptx/html2pptx.md +625 -0
  122. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
  123. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
  124. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
  125. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
  126. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
  127. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
  128. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
  129. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
  130. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
  131. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
  132. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
  133. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
  134. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
  135. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
  136. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
  137. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
  138. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
  139. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
  140. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
  141. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
  142. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
  143. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
  144. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
  145. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
  146. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
  147. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
  148. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
  149. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
  150. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
  151. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
  152. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
  153. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/mce/mc.xsd +75 -0
  154. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
  155. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
  156. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
  157. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
  158. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
  159. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
  160. scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
  161. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/pack.py +159 -0
  162. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/unpack.py +29 -0
  163. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validate.py +69 -0
  164. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/__init__.py +15 -0
  165. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/base.py +951 -0
  166. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/docx.py +274 -0
  167. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/pptx.py +315 -0
  168. scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/redlining.py +279 -0
  169. scientific_writer/.claude/skills/document-skills/pptx/ooxml.md +427 -0
  170. scientific_writer/.claude/skills/document-skills/pptx/scripts/html2pptx.js +979 -0
  171. scientific_writer/.claude/skills/document-skills/pptx/scripts/inventory.py +1020 -0
  172. scientific_writer/.claude/skills/document-skills/pptx/scripts/rearrange.py +231 -0
  173. scientific_writer/.claude/skills/document-skills/pptx/scripts/replace.py +385 -0
  174. scientific_writer/.claude/skills/document-skills/pptx/scripts/thumbnail.py +450 -0
  175. scientific_writer/.claude/skills/document-skills/xlsx/LICENSE.txt +30 -0
  176. scientific_writer/.claude/skills/document-skills/xlsx/SKILL.md +289 -0
  177. scientific_writer/.claude/skills/document-skills/xlsx/recalc.py +178 -0
  178. scientific_writer/.claude/skills/hypothesis-generation/SKILL.md +155 -0
  179. scientific_writer/.claude/skills/hypothesis-generation/assets/hypothesis_output_template.md +302 -0
  180. scientific_writer/.claude/skills/hypothesis-generation/references/experimental_design_patterns.md +327 -0
  181. scientific_writer/.claude/skills/hypothesis-generation/references/hypothesis_quality_criteria.md +196 -0
  182. scientific_writer/.claude/skills/hypothesis-generation/references/literature_search_strategies.md +505 -0
  183. scientific_writer/.claude/skills/latex-posters/README.md +417 -0
  184. scientific_writer/.claude/skills/latex-posters/SKILL.md +919 -0
  185. scientific_writer/.claude/skills/latex-posters/assets/baposter_template.tex +257 -0
  186. scientific_writer/.claude/skills/latex-posters/assets/beamerposter_template.tex +244 -0
  187. scientific_writer/.claude/skills/latex-posters/assets/poster_quality_checklist.md +358 -0
  188. scientific_writer/.claude/skills/latex-posters/assets/tikzposter_template.tex +251 -0
  189. scientific_writer/.claude/skills/latex-posters/references/latex_poster_packages.md +745 -0
  190. scientific_writer/.claude/skills/latex-posters/references/poster_content_guide.md +748 -0
  191. scientific_writer/.claude/skills/latex-posters/references/poster_design_principles.md +806 -0
  192. scientific_writer/.claude/skills/latex-posters/references/poster_layout_design.md +900 -0
  193. scientific_writer/.claude/skills/latex-posters/scripts/review_poster.sh +214 -0
  194. scientific_writer/.claude/skills/literature-review/SKILL.md +546 -0
  195. scientific_writer/.claude/skills/literature-review/assets/review_template.md +412 -0
  196. scientific_writer/.claude/skills/literature-review/references/citation_styles.md +166 -0
  197. scientific_writer/.claude/skills/literature-review/references/database_strategies.md +381 -0
  198. scientific_writer/.claude/skills/literature-review/scripts/generate_pdf.py +176 -0
  199. scientific_writer/.claude/skills/literature-review/scripts/search_databases.py +303 -0
  200. scientific_writer/.claude/skills/literature-review/scripts/verify_citations.py +222 -0
  201. scientific_writer/.claude/skills/markitdown/INSTALLATION_GUIDE.md +318 -0
  202. scientific_writer/.claude/skills/markitdown/LICENSE.txt +22 -0
  203. scientific_writer/.claude/skills/markitdown/OPENROUTER_INTEGRATION.md +359 -0
  204. scientific_writer/.claude/skills/markitdown/QUICK_REFERENCE.md +309 -0
  205. scientific_writer/.claude/skills/markitdown/README.md +184 -0
  206. scientific_writer/.claude/skills/markitdown/SKILL.md +450 -0
  207. scientific_writer/.claude/skills/markitdown/SKILL_SUMMARY.md +307 -0
  208. scientific_writer/.claude/skills/markitdown/assets/example_usage.md +463 -0
  209. scientific_writer/.claude/skills/markitdown/references/api_reference.md +399 -0
  210. scientific_writer/.claude/skills/markitdown/references/file_formats.md +542 -0
  211. scientific_writer/.claude/skills/markitdown/scripts/batch_convert.py +228 -0
  212. scientific_writer/.claude/skills/markitdown/scripts/convert_literature.py +283 -0
  213. scientific_writer/.claude/skills/markitdown/scripts/convert_with_ai.py +243 -0
  214. scientific_writer/.claude/skills/paper-2-web/SKILL.md +455 -0
  215. scientific_writer/.claude/skills/paper-2-web/references/installation.md +141 -0
  216. scientific_writer/.claude/skills/paper-2-web/references/paper2poster.md +346 -0
  217. scientific_writer/.claude/skills/paper-2-web/references/paper2video.md +305 -0
  218. scientific_writer/.claude/skills/paper-2-web/references/paper2web.md +187 -0
  219. scientific_writer/.claude/skills/paper-2-web/references/usage_examples.md +436 -0
  220. scientific_writer/.claude/skills/peer-review/SKILL.md +375 -0
  221. scientific_writer/.claude/skills/peer-review/references/common_issues.md +552 -0
  222. scientific_writer/.claude/skills/peer-review/references/reporting_standards.md +290 -0
  223. scientific_writer/.claude/skills/research-grants/README.md +285 -0
  224. scientific_writer/.claude/skills/research-grants/SKILL.md +896 -0
  225. scientific_writer/.claude/skills/research-grants/assets/budget_justification_template.md +453 -0
  226. scientific_writer/.claude/skills/research-grants/assets/nih_specific_aims_template.md +166 -0
  227. scientific_writer/.claude/skills/research-grants/assets/nsf_project_summary_template.md +92 -0
  228. scientific_writer/.claude/skills/research-grants/references/broader_impacts.md +392 -0
  229. scientific_writer/.claude/skills/research-grants/references/darpa_guidelines.md +636 -0
  230. scientific_writer/.claude/skills/research-grants/references/doe_guidelines.md +586 -0
  231. scientific_writer/.claude/skills/research-grants/references/nih_guidelines.md +851 -0
  232. scientific_writer/.claude/skills/research-grants/references/nsf_guidelines.md +570 -0
  233. scientific_writer/.claude/skills/research-grants/references/specific_aims_guide.md +458 -0
  234. scientific_writer/.claude/skills/research-lookup/README.md +116 -0
  235. scientific_writer/.claude/skills/research-lookup/SKILL.md +443 -0
  236. scientific_writer/.claude/skills/research-lookup/examples.py +174 -0
  237. scientific_writer/.claude/skills/research-lookup/lookup.py +93 -0
  238. scientific_writer/.claude/skills/research-lookup/research_lookup.py +335 -0
  239. scientific_writer/.claude/skills/research-lookup/scripts/research_lookup.py +261 -0
  240. scientific_writer/.claude/skills/scholar-evaluation/SKILL.md +254 -0
  241. scientific_writer/.claude/skills/scholar-evaluation/references/evaluation_framework.md +663 -0
  242. scientific_writer/.claude/skills/scholar-evaluation/scripts/calculate_scores.py +378 -0
  243. scientific_writer/.claude/skills/scientific-critical-thinking/SKILL.md +530 -0
  244. scientific_writer/.claude/skills/scientific-critical-thinking/references/common_biases.md +364 -0
  245. scientific_writer/.claude/skills/scientific-critical-thinking/references/evidence_hierarchy.md +484 -0
  246. scientific_writer/.claude/skills/scientific-critical-thinking/references/experimental_design.md +496 -0
  247. scientific_writer/.claude/skills/scientific-critical-thinking/references/logical_fallacies.md +478 -0
  248. scientific_writer/.claude/skills/scientific-critical-thinking/references/scientific_method.md +169 -0
  249. scientific_writer/.claude/skills/scientific-critical-thinking/references/statistical_pitfalls.md +506 -0
  250. scientific_writer/.claude/skills/scientific-schematics/SKILL.md +2035 -0
  251. scientific_writer/.claude/skills/scientific-schematics/assets/block_diagram_template.tex +199 -0
  252. scientific_writer/.claude/skills/scientific-schematics/assets/circuit_template.tex +159 -0
  253. scientific_writer/.claude/skills/scientific-schematics/assets/flowchart_template.tex +161 -0
  254. scientific_writer/.claude/skills/scientific-schematics/assets/pathway_template.tex +162 -0
  255. scientific_writer/.claude/skills/scientific-schematics/assets/tikz_styles.tex +422 -0
  256. scientific_writer/.claude/skills/scientific-schematics/references/best_practices.md +562 -0
  257. scientific_writer/.claude/skills/scientific-schematics/references/diagram_types.md +637 -0
  258. scientific_writer/.claude/skills/scientific-schematics/references/python_libraries.md +791 -0
  259. scientific_writer/.claude/skills/scientific-schematics/references/tikz_guide.md +734 -0
  260. scientific_writer/.claude/skills/scientific-schematics/scripts/circuit_generator.py +307 -0
  261. scientific_writer/.claude/skills/scientific-schematics/scripts/compile_tikz.py +292 -0
  262. scientific_writer/.claude/skills/scientific-schematics/scripts/generate_flowchart.py +281 -0
  263. scientific_writer/.claude/skills/scientific-schematics/scripts/pathway_diagram.py +406 -0
  264. scientific_writer/.claude/skills/scientific-writing/SKILL.md +443 -0
  265. scientific_writer/.claude/skills/scientific-writing/references/citation_styles.md +720 -0
  266. scientific_writer/.claude/skills/scientific-writing/references/figures_tables.md +806 -0
  267. scientific_writer/.claude/skills/scientific-writing/references/imrad_structure.md +658 -0
  268. scientific_writer/.claude/skills/scientific-writing/references/reporting_guidelines.md +748 -0
  269. scientific_writer/.claude/skills/scientific-writing/references/writing_principles.md +824 -0
  270. scientific_writer/.claude/skills/treatment-plans/README.md +488 -0
  271. scientific_writer/.claude/skills/treatment-plans/SKILL.md +1536 -0
  272. scientific_writer/.claude/skills/treatment-plans/assets/STYLING_QUICK_REFERENCE.md +185 -0
  273. scientific_writer/.claude/skills/treatment-plans/assets/chronic_disease_management_plan.tex +665 -0
  274. scientific_writer/.claude/skills/treatment-plans/assets/general_medical_treatment_plan.tex +547 -0
  275. scientific_writer/.claude/skills/treatment-plans/assets/medical_treatment_plan.sty +222 -0
  276. scientific_writer/.claude/skills/treatment-plans/assets/mental_health_treatment_plan.tex +774 -0
  277. scientific_writer/.claude/skills/treatment-plans/assets/one_page_treatment_plan.tex +193 -0
  278. scientific_writer/.claude/skills/treatment-plans/assets/pain_management_plan.tex +799 -0
  279. scientific_writer/.claude/skills/treatment-plans/assets/perioperative_care_plan.tex +753 -0
  280. scientific_writer/.claude/skills/treatment-plans/assets/quality_checklist.md +471 -0
  281. scientific_writer/.claude/skills/treatment-plans/assets/rehabilitation_treatment_plan.tex +756 -0
  282. scientific_writer/.claude/skills/treatment-plans/references/goal_setting_frameworks.md +411 -0
  283. scientific_writer/.claude/skills/treatment-plans/references/intervention_guidelines.md +507 -0
  284. scientific_writer/.claude/skills/treatment-plans/references/regulatory_compliance.md +476 -0
  285. scientific_writer/.claude/skills/treatment-plans/references/specialty_specific_guidelines.md +655 -0
  286. scientific_writer/.claude/skills/treatment-plans/references/treatment_plan_standards.md +485 -0
  287. scientific_writer/.claude/skills/treatment-plans/scripts/check_completeness.py +318 -0
  288. scientific_writer/.claude/skills/treatment-plans/scripts/generate_template.py +244 -0
  289. scientific_writer/.claude/skills/treatment-plans/scripts/timeline_generator.py +369 -0
  290. scientific_writer/.claude/skills/treatment-plans/scripts/validate_treatment_plan.py +367 -0
  291. scientific_writer/.claude/skills/venue-templates/SKILL.md +590 -0
  292. scientific_writer/.claude/skills/venue-templates/assets/grants/nih_specific_aims.tex +235 -0
  293. scientific_writer/.claude/skills/venue-templates/assets/grants/nsf_proposal_template.tex +375 -0
  294. scientific_writer/.claude/skills/venue-templates/assets/journals/nature_article.tex +171 -0
  295. scientific_writer/.claude/skills/venue-templates/assets/journals/neurips_article.tex +283 -0
  296. scientific_writer/.claude/skills/venue-templates/assets/journals/plos_one.tex +317 -0
  297. scientific_writer/.claude/skills/venue-templates/assets/posters/beamerposter_academic.tex +311 -0
  298. scientific_writer/.claude/skills/venue-templates/references/conferences_formatting.md +564 -0
  299. scientific_writer/.claude/skills/venue-templates/references/grants_requirements.md +787 -0
  300. scientific_writer/.claude/skills/venue-templates/references/journals_formatting.md +486 -0
  301. scientific_writer/.claude/skills/venue-templates/references/posters_guidelines.md +628 -0
  302. scientific_writer/.claude/skills/venue-templates/scripts/customize_template.py +206 -0
  303. scientific_writer/.claude/skills/venue-templates/scripts/query_template.py +260 -0
  304. scientific_writer/.claude/skills/venue-templates/scripts/validate_format.py +255 -0
  305. scientific_writer/__init__.py +43 -0
  306. scientific_writer/api.py +393 -0
  307. scientific_writer/cli.py +326 -0
  308. scientific_writer/core.py +275 -0
  309. scientific_writer/models.py +76 -0
  310. scientific_writer/utils.py +289 -0
  311. scientific_writer-2.3.1.dist-info/METADATA +272 -0
  312. scientific_writer-2.3.1.dist-info/RECORD +315 -0
  313. scientific_writer-2.3.1.dist-info/WHEEL +4 -0
  314. scientific_writer-2.3.1.dist-info/entry_points.txt +2 -0
  315. scientific_writer-2.3.1.dist-info/licenses/LICENSE +22 -0
@@ -0,0 +1,806 @@
1
+ # Figures and Tables Best Practices
2
+
3
+ ## Overview
4
+
5
+ Figures and tables are essential components of scientific papers, serving to display data patterns, summarize results, and provide evidence for conclusions. Effective visual displays enhance comprehension and can sustain reader interest while illustrating trends, patterns, and relationships not easily conveyed through text alone.
6
+
7
+ A recent Nature Cell Biology checklist (2025) emphasizes that creating clear and engaging scientific figures is crucial for communicating complex data with clarity, accessibility, and design excellence.
8
+
9
+ ## When to Use Tables vs. Figures
10
+
11
+ ### Use Tables When:
12
+ - Presenting precise numerical values that readers need to reference
13
+ - Comparing exact measurements across multiple variables
14
+ - Showing detailed statistical outputs
15
+ - Data cannot be adequately summarized in 1-2 sentences
16
+ - Readers need access to specific data points
17
+ - Displaying demographic or baseline characteristics
18
+ - Presenting multiple related statistical tests
19
+
20
+ **Example use cases:**
21
+ - Baseline participant characteristics (age, sex, diagnosis, etc.)
22
+ - Detailed statistical model outputs (coefficients, p-values, confidence intervals)
23
+ - Dose-response data with exact values
24
+ - Gene expression levels for specific genes
25
+ - Chemical compositions or concentrations
26
+
27
+ ### Use Figures When:
28
+ - Showing trends over time
29
+ - Displaying relationships or correlations
30
+ - Comparing groups visually
31
+ - Illustrating distributions
32
+ - Demonstrating patterns not easily seen in numbers
33
+ - Showing images (microscopy, radiography, etc.)
34
+ - Displaying workflows, diagrams, or schematics
35
+
36
+ **Example use cases:**
37
+ - Growth curves or time series
38
+ - Dose-response curves
39
+ - Scatter plots showing correlations
40
+ - Bar graphs comparing treatment groups
41
+ - Histograms showing distributions
42
+ - Heatmaps displaying patterns across conditions
43
+ - Microscopy images or Western blots
44
+
45
+ ### General Decision Rule
46
+
47
+ **Can the information be conveyed in 1-2 sentences of text?**
48
+ - Yes → Use text only
49
+ - No, and precise values are needed → Use a table
50
+ - No, and patterns/trends are most important → Use a figure
51
+
52
+ ## Core Design Principles
53
+
54
+ ### 1. Self-Explanatory Display Items
55
+
56
+ **Each figure or table must stand alone without requiring the main text.**
57
+
58
+ **Essential elements:**
59
+ - Complete, descriptive caption
60
+ - All abbreviations defined (in caption or footnote)
61
+ - Units of measurement clearly indicated
62
+ - Sample sizes (n) reported
63
+ - Statistical significance annotations explained
64
+ - Legend included (for figures with multiple data series)
65
+
66
+ **Example of self-explanatory caption:**
67
+ ```
68
+ Figure 1. Mean systolic blood pressure (SBP) over 12 weeks in intervention and control groups.
69
+ Error bars represent standard error of the mean (SEM). Asterisks indicate significant
70
+ differences between groups at each time point (*p < 0.05, **p < 0.01, ***p < 0.001,
71
+ two-tailed t-tests). n = 48 per group. BP = blood pressure; SEM = standard error of mean.
72
+ ```
73
+
74
+ ### 2. Avoid Redundancy
75
+
76
+ **Do not duplicate information between text, tables, and figures.**
77
+
78
+ **Bad practice:**
79
+ ```
80
+ "Mean age was 45.2 years in Group A and 47.8 years in Group B. Mean BMI was 26.3 in
81
+ Group A and 28.1 in Group B. Mean systolic blood pressure was 132 mmHg in Group A..."
82
+ [Also shown in Table 1]
83
+ ```
84
+
85
+ **Good practice:**
86
+ ```
87
+ "Baseline characteristics were similar between groups (Table 1), with no significant
88
+ differences in age, BMI, or blood pressure (all p > 0.15)."
89
+ [Details in Table 1]
90
+ ```
91
+
92
+ **Key principle:** Text should highlight key findings from tables/figures, not repeat all data.
93
+
94
+ ### 3. Consistency
95
+
96
+ **Maintain uniform formatting across all display items:**
97
+ - Font types and sizes
98
+ - Color schemes
99
+ - Terminology and abbreviations
100
+ - Axis labels and units
101
+ - Statistical annotation methods
102
+ - Figure styles (all line graphs should look similar)
103
+
104
+ **Example of inconsistency to avoid:**
105
+ - Figure 1 uses "standard error" while Figure 2 uses "SE"
106
+ - Figure 1 has blue/red color scheme while Figure 2 uses green/yellow
107
+ - Table 1 reports p-values as "p = 0.023" while Table 2 uses "p-value = .023"
108
+
109
+ ### 4. Optimal Quantity
110
+
111
+ **Follow the "one display item per 1000 words" guideline.**
112
+
113
+ **Typical manuscript:**
114
+ - 3000-4000 words → 3-4 tables/figures total
115
+ - 5000-6000 words → 5-6 tables/figures total
116
+
117
+ **Quality over quantity:** A few well-designed, information-rich displays are better than many redundant or poorly designed ones.
118
+
119
+ ### 5. Clarity and Simplicity
120
+
121
+ **Avoid cluttered or overly complex displays:**
122
+ - Don't include too many variables in one figure
123
+ - Use clear, readable fonts (minimum 8-10 pt in final size)
124
+ - Provide adequate spacing between elements
125
+ - Use high contrast (especially for color-blind accessibility)
126
+ - Remove unnecessary grid lines, borders, or decoration
127
+ - Maximize data-ink ratio (Tufte principle: minimize non-data ink)
128
+
129
+ ## Figure Types and When to Use Them
130
+
131
+ ### Bar Graphs
132
+
133
+ **Best for:**
134
+ - Comparing discrete categories or groups
135
+ - Showing counts or frequencies
136
+ - Displaying mean values with error bars
137
+
138
+ **Design guidelines:**
139
+ - Start y-axis at zero (unless showing small differences in large values)
140
+ - Order bars logically (by size, alphabetically, or temporally)
141
+ - Use error bars (SD, SEM, or CI) consistently
142
+ - Include sample sizes
143
+ - Avoid 3D effects (they distort perception)
144
+
145
+ **Common mistakes:**
146
+ - Not starting at zero (can exaggerate differences)
147
+ - Too many categories (consider table instead)
148
+ - Missing error bars
149
+
150
+ **Example applications:**
151
+ - Mean gene expression across tissue types
152
+ - Treatment group comparisons
153
+ - Frequency of adverse events
154
+
155
+ ### Line Graphs
156
+
157
+ **Best for:**
158
+ - Showing trends over continuous variables (usually time)
159
+ - Displaying multiple groups on same axes
160
+ - Illustrating dose-response relationships
161
+
162
+ **Design guidelines:**
163
+ - Use different line styles or colors for groups
164
+ - Include data point markers for sparse data
165
+ - Show error bars or shaded confidence intervals
166
+ - Label axes clearly with units
167
+ - Use consistent intervals on x-axis
168
+
169
+ **Common mistakes:**
170
+ - Connecting discrete data points that shouldn't be connected
171
+ - Too many lines making graph unreadable
172
+ - Inconsistent time intervals without indication
173
+
174
+ **Example applications:**
175
+ - Growth curves
176
+ - Time course experiments
177
+ - Survival curves (Kaplan-Meier plots)
178
+ - Pharmacokinetic profiles
179
+
180
+ ### Scatter Plots
181
+
182
+ **Best for:**
183
+ - Showing relationships between two continuous variables
184
+ - Displaying correlations
185
+ - Identifying outliers
186
+
187
+ **Design guidelines:**
188
+ - Include trend line or regression line with equation and R²
189
+ - Report correlation coefficient and p-value
190
+ - Use semi-transparent points if data overlap
191
+ - Consider logarithmic scales for wide ranges
192
+ - Mark outliers if relevant
193
+
194
+ **Common mistakes:**
195
+ - Not showing individual data points
196
+ - Using scatter plots for categorical data
197
+ - Missing correlation statistics
198
+
199
+ **Example applications:**
200
+ - Correlation between biomarkers
201
+ - Relationship between dose and response
202
+ - Method comparison (Bland-Altman plots)
203
+
204
+ ### Box Plots (Box-and-Whisker Plots)
205
+
206
+ **Best for:**
207
+ - Showing distributions and spread
208
+ - Comparing distributions across groups
209
+ - Identifying outliers
210
+
211
+ **Design guidelines:**
212
+ - Clearly define box elements (median, quartiles, whiskers)
213
+ - Show or note outliers explicitly
214
+ - Consider violin plots for small sample sizes
215
+ - Overlay individual data points when n < 20
216
+
217
+ **Common mistakes:**
218
+ - Not defining what whiskers represent
219
+ - Using for very small samples without showing raw data
220
+ - Not marking outliers
221
+
222
+ **Example applications:**
223
+ - Comparing distributions across treatment groups
224
+ - Showing variability in measurements
225
+ - Quality control data
226
+
227
+ ### Heatmaps
228
+
229
+ **Best for:**
230
+ - Displaying matrices of data
231
+ - Showing patterns across many conditions
232
+ - Representing clustering or grouping
233
+
234
+ **Design guidelines:**
235
+ - Use color scales that are perceptually uniform
236
+ - Include color scale bar with units
237
+ - Consider hierarchical clustering for rows/columns
238
+ - Use appropriate color scheme (diverging vs. sequential)
239
+ - Make axes labels readable
240
+
241
+ **Common mistakes:**
242
+ - Poor color choice (rainbow scales are often misleading)
243
+ - Too many rows/columns making labels unreadable
244
+ - No color scale bar
245
+
246
+ **Example applications:**
247
+ - Gene expression across samples
248
+ - Correlation matrices
249
+ - Time-series data across multiple variables
250
+
251
+ ### Images (Microscopy, Gels, Blots)
252
+
253
+ **Best for:**
254
+ - Showing representative examples
255
+ - Demonstrating morphology or localization
256
+ - Presenting gel electrophoresis or Western blots
257
+
258
+ **Design guidelines:**
259
+ - Include scale bars (not magnification in caption)
260
+ - Show representative images with quantification in separate panel
261
+ - Label important features with arrows or labels
262
+ - Ensure adequate resolution (usually 300+ dpi)
263
+ - Show full, unmanipulated images with cropping noted
264
+ - Include all relevant controls
265
+
266
+ **Common mistakes:**
267
+ - No scale bar
268
+ - Over-processed or manipulated images
269
+ - Cherry-picking best images without quantification
270
+ - Insufficient resolution
271
+
272
+ **Example applications:**
273
+ - Histological sections
274
+ - Immunofluorescence
275
+ - Western blots
276
+ - Gel electrophoresis
277
+
278
+ ### Forest Plots
279
+
280
+ **Best for:**
281
+ - Displaying meta-analysis results
282
+ - Showing effect sizes with confidence intervals
283
+ - Comparing multiple studies or subgroups
284
+
285
+ **Design guidelines:**
286
+ - Include point estimates and CI for each study
287
+ - Show overall pooled estimate clearly
288
+ - Include line of no effect (typically at 1.0 or 0)
289
+ - List study details or weights
290
+
291
+ **Example applications:**
292
+ - Meta-analyses
293
+ - Systematic reviews
294
+ - Subgroup analyses
295
+
296
+ ### Flow Diagrams
297
+
298
+ **Best for:**
299
+ - Study participant flow (CONSORT diagrams)
300
+ - Systematic review search process (PRISMA diagrams)
301
+ - Experimental workflows
302
+
303
+ **Design guidelines:**
304
+ - Follow reporting guideline templates (CONSORT, PRISMA)
305
+ - Use consistent shapes and connectors
306
+ - Include numbers at each stage
307
+ - Clearly show inclusions and exclusions
308
+
309
+ ## Table Design Guidelines
310
+
311
+ ### Structure
312
+
313
+ **Basic anatomy:**
314
+ 1. **Table number and title** (above table)
315
+ 2. **Column headers** (with units)
316
+ 3. **Row labels**
317
+ 4. **Data cells** (with appropriate precision)
318
+ 5. **Footnotes** (below table for abbreviations, statistics, notes)
319
+
320
+ ### Formatting Best Practices
321
+
322
+ **Column headers:**
323
+ - Use clear, concise labels
324
+ - Include units in parentheses
325
+ - Use abbreviations sparingly (define in footnote)
326
+
327
+ **Data presentation:**
328
+ - Align decimal points in columns
329
+ - Use consistent decimal places (usually 1-2 for means)
330
+ - Report same precision across rows/columns
331
+ - Use en-dash (–) for "not applicable"
332
+ - Use appropriate precision (don't over-report)
333
+
334
+ **Statistical annotations:**
335
+ - Use superscript letters (ᵃ, ᵇ, ᶜ) or symbols (*, †, ‡) for footnotes
336
+ - Define p-value thresholds clearly
337
+ - Report exact p-values when possible (p = 0.032, not p < 0.05)
338
+
339
+ **Footnotes:**
340
+ - Define all abbreviations
341
+ - Explain statistical tests used
342
+ - Note any missing data
343
+ - Indicate data source if not original
344
+
345
+ ### Example Table Format
346
+
347
+ ```
348
+ Table 1. Baseline Characteristics of Study Participants
349
+
350
+ Characteristic Intervention (n=50) Control (n=48) p-value
351
+ ─────────────────────────────────────────────────────────────────────────
352
+ Age, years 45.3 ± 8.2 47.1 ± 9.1 0.28
353
+ Male sex, n (%) 28 (56) 25 (52) 0.71
354
+ BMI, kg/m² 26.3 ± 3.8 27.1 ± 4.2 0.32
355
+ Current smoker, n (%) 12 (24) 15 (31) 0.42
356
+ Systolic BP, mmHg 132 ± 15 134 ± 18 0.54
357
+ ─────────────────────────────────────────────────────────────────────────
358
+
359
+ Data presented as mean ± SD or n (%). p-values from independent t-tests for
360
+ continuous variables and χ² tests for categorical variables. BMI = body mass
361
+ index; BP = blood pressure; SD = standard deviation.
362
+ ```
363
+
364
+ ### Common Table Mistakes
365
+
366
+ 1. **Excessive complexity** (too many rows/columns)
367
+ 2. **Insufficient context** (missing units, unclear abbreviations)
368
+ 3. **Over-precision** (reporting 5 decimal places for p-values)
369
+ 4. **Missing sample sizes**
370
+ 5. **No statistical comparisons when appropriate**
371
+ 6. **Inconsistent formatting** across multiple tables
372
+ 7. **Duplicate information** with figures or text
373
+
374
+ ## Statistical Presentation in Figures and Tables
375
+
376
+ ### Reporting Requirements
377
+
378
+ **For each comparison, report:**
379
+ 1. **Point estimate** (mean, median, proportion)
380
+ 2. **Measure of variability** (SD, SEM, CI)
381
+ 3. **Sample size** (n)
382
+ 4. **Test statistic** (t, F, χ², etc.)
383
+ 5. **p-value** (exact when p > 0.001)
384
+ 6. **Effect size** (when appropriate)
385
+
386
+ ### Error Bars
387
+
388
+ **Choose the appropriate measure:**
389
+
390
+ | Measure | Meaning | When to Use |
391
+ |---------|---------|-------------|
392
+ | **SD (Standard Deviation)** | Variability in the data | Showing data spread |
393
+ | **SEM (Standard Error of Mean)** | Precision of mean estimate | Showing measurement precision |
394
+ | **95% CI (Confidence Interval)** | Range likely to contain true mean | Showing statistical significance |
395
+
396
+ **Key rule:** Always state which measure is shown.
397
+
398
+ **Example caption:**
399
+ ```
400
+ "Error bars represent 95% confidence intervals."
401
+ NOT: "Error bars represent standard error."
402
+ ```
403
+
404
+ **Recommendation:** 95% CI preferred because non-overlapping CIs indicate significant differences.
405
+
406
+ ### Significance Indicators
407
+
408
+ **Common notation:**
409
+ ```
410
+ * p < 0.05
411
+ ** p < 0.01
412
+ *** p < 0.001
413
+ n.s. or NS = not significant
414
+ ```
415
+
416
+ **Alternative:** Show exact p-values in table or caption
417
+
418
+ **Best practice:** Define significance indicators in every figure caption or table footnote.
419
+
420
+ ## Accessibility Considerations
421
+
422
+ ### Color-Blind Friendly Design
423
+
424
+ **Recommendations:**
425
+ - Use color palettes designed for color-blind accessibility
426
+ - Don't rely on color alone (add patterns, shapes, or labels)
427
+ - Test figures in grayscale
428
+ - Avoid red-green combinations
429
+
430
+ **Color-blind safe palettes:**
431
+ - Blue-Orange
432
+ - Purple-Yellow
433
+ - Colorbrewer2.org palettes
434
+ - Viridis, Plasma, Inferno (for heatmaps)
435
+
436
+ ### High Contrast
437
+
438
+ **Ensure readability:**
439
+ - Dark text on light background (or vice versa)
440
+ - Avoid low-contrast color combinations (gray on gray)
441
+ - Use thick enough lines (minimum 0.5-1 pt)
442
+ - Large enough text (minimum 8-10 pt after scaling)
443
+
444
+ ### Screen and Print Compatibility
445
+
446
+ **Design for both media:**
447
+ - Use vector formats when possible (PDF, EPS, SVG)
448
+ - Minimum 300 dpi for raster images (TIFF, PNG)
449
+ - Test appearance at final print size
450
+ - Ensure color figures work in grayscale if printed
451
+
452
+ ## Technical Requirements
453
+
454
+ ### File Formats
455
+
456
+ **Vector formats** (preferred for graphs and diagrams):
457
+ - **PDF**: Universal, preserves quality
458
+ - **EPS**: Encapsulated PostScript, publishing standard
459
+ - **SVG**: Scalable vector graphics, web-friendly
460
+
461
+ **Raster formats** (for photos and images):
462
+ - **TIFF**: Uncompressed, high quality, large files
463
+ - **PNG**: Lossless compression, good for screen
464
+ - **JPEG**: Lossy compression, avoid for data figures
465
+
466
+ **Avoid:**
467
+ - Low-resolution screenshots
468
+ - Figures copied from presentations (usually too low resolution)
469
+ - Heavily compressed JPEGs (artifacts)
470
+
471
+ ### Resolution Requirements
472
+
473
+ **Minimum standards:**
474
+ - **Line art** (graphs, diagrams): 300-600 dpi
475
+ - **Halftones** (photos, grayscale): 300 dpi
476
+ - **Combination** (images with labels): 300-600 dpi
477
+
478
+ **Best practice:** Create figures at final size and resolution.
479
+
480
+ ### Dimensions
481
+
482
+ **Check journal requirements:**
483
+ - **Single column**: typically 8-9 cm (3-3.5 inches) wide
484
+ - **Double column**: typically 17-18 cm (6.5-7 inches) wide
485
+ - **Full page**: varies by journal
486
+
487
+ **Recommendation:** Design figures to fit single column when possible.
488
+
489
+ ### Image Manipulation
490
+
491
+ **Allowed:**
492
+ - Brightness/contrast adjustment applied to entire image
493
+ - Color balance adjustment
494
+ - Cropping (with notation)
495
+ - Rotation
496
+
497
+ **NOT allowed:**
498
+ - Selective editing (e.g., enhancing bands in gels)
499
+ - Removing background artifacts
500
+ - Splicing images without clear indication
501
+ - Any manipulation that obscures, eliminates, or misrepresents data
502
+
503
+ **Ethical requirement:** Report all image adjustments in Methods section.
504
+
505
+ ## Figure and Table Numbering
506
+
507
+ ### Numbering System
508
+
509
+ **Figures:**
510
+ - Number consecutively in order of first mention in text
511
+ - Use Arabic numerals: Figure 1, Figure 2, Figure 3...
512
+ - Supplementary figures: Figure S1, Figure S2...
513
+
514
+ **Tables:**
515
+ - Number separately from figures
516
+ - Use Arabic numerals: Table 1, Table 2, Table 3...
517
+ - Supplementary tables: Table S1, Table S2...
518
+
519
+ ### In-Text References
520
+
521
+ **Format:**
522
+ ```
523
+ "Results are shown in Figure 1."
524
+ "Participant characteristics are presented in Table 2."
525
+ "Multiple analyses confirmed this finding (Figures 3-5)."
526
+ ```
527
+
528
+ **NOT:**
529
+ ```
530
+ "Figure 1 below shows..." (avoid "above" or "below" - pagination may change)
531
+ "The figure shows..." (always use specific number)
532
+ ```
533
+
534
+ ## Captions
535
+
536
+ ### Caption Structure
537
+
538
+ **For figures:**
539
+ ```
540
+ Figure 1. [One-sentence title]. [Additional description sentences providing context,
541
+ defining abbreviations, explaining panels, describing statistical tests, and noting
542
+ sample sizes].
543
+ ```
544
+
545
+ **For tables:**
546
+ ```
547
+ Table 1. [Descriptive Title]
548
+ [Table contents]
549
+ [Footnotes defining abbreviations, statistical methods, and providing additional context]
550
+ ```
551
+
552
+ ### Caption Content
553
+
554
+ **Essential information:**
555
+ 1. What is being shown (brief title)
556
+ 2. Detailed description of content
557
+ 3. Definition of all abbreviations and symbols
558
+ 4. Sample sizes
559
+ 5. Statistical tests used
560
+ 6. Meaning of error bars or annotations
561
+ 7. Panel labels explained (if multiple panels)
562
+
563
+ **Example comprehensive caption:**
564
+ ```
565
+ Figure 3. Cognitive performance improves with treatment over 12 weeks. (A) Mean Mini-Mental
566
+ State Examination (MMSE) scores at baseline, 6 weeks, and 12 weeks for treatment (blue) and
567
+ placebo (gray) groups. (B) Individual participant trajectories for treatment group. Error bars
568
+ represent 95% confidence intervals. Asterisks indicate significant between-group differences
569
+ (*p < 0.05, **p < 0.01, ***p < 0.001; repeated measures ANOVA with Bonferroni correction).
570
+ n = 42 treatment, n = 40 placebo. MMSE scores range from 0-30, with higher scores indicating
571
+ better cognitive function.
572
+ ```
573
+
574
+ ## Journal-Specific Requirements
575
+
576
+ ### Before Creating Figures/Tables
577
+
578
+ **Check journal guidelines for:**
579
+ - Preferred file formats
580
+ - Resolution requirements
581
+ - Color specifications (RGB vs. CMYK)
582
+ - Maximum number of display items
583
+ - Dimension requirements
584
+ - Font restrictions
585
+ - Whether to embed figures in manuscript or submit separately
586
+
587
+ ### During Submission
588
+
589
+ **Prepare checklist:**
590
+ - [ ] All figures/tables numbered correctly
591
+ - [ ] All cited in text in order
592
+ - [ ] Captions complete and self-explanatory
593
+ - [ ] Abbreviations defined
594
+ - [ ] Correct file format and resolution
595
+ - [ ] Appropriate size/dimensions
596
+ - [ ] High enough quality for print
597
+ - [ ] Color-blind friendly (if using color)
598
+ - [ ] Permissions obtained (if adapting from others' work)
599
+
600
+ ## Common Pitfalls to Avoid
601
+
602
+ ### Content Issues
603
+ 1. **Duplication** between text, tables, and figures
604
+ 2. **Insufficient context** (unclear what is shown)
605
+ 3. **Too much information** in one display
606
+ 4. **Missing key information** (sample sizes, units, statistics)
607
+ 5. **Cherry-picking** data without showing full picture
608
+
609
+ ### Design Issues
610
+ 6. **Poor color choices** (not color-blind friendly)
611
+ 7. **Inconsistent formatting** across displays
612
+ 8. **Cluttered or busy designs**
613
+ 9. **Too small text** at final size
614
+ 10. **Misleading visualizations** (truncated axes, 3D distortions)
615
+
616
+ ### Technical Issues
617
+ 11. **Insufficient resolution** (pixelated when printed)
618
+ 12. **Wrong file format** (lossy compression, non-vector graphs)
619
+ 13. **Improper image manipulation** (undeclared editing)
620
+ 14. **Missing scale bars** on images
621
+ 15. **Figures that don't work in grayscale** (if journal prints in B&W)
622
+
623
+ ## Tools for Creating Figures
624
+
625
+ ### Graphing Software
626
+ - **R (ggplot2)**: Highly customizable, publication-quality, reproducible
627
+ - **Python (matplotlib, seaborn)**: Flexible, programmable, widely used
628
+ - **GraphPad Prism**: User-friendly, statistics integrated, common in life sciences
629
+ - **Origin**: Advanced graphing, popular in physics/engineering
630
+ - **Excel**: Basic graphs, widely available, limited customization
631
+ - **MATLAB**: Technical computing, good for complex visualizations
632
+
633
+ ### Image Processing
634
+ - **ImageJ/Fiji**: Free, powerful, widely used in microscopy
635
+ - **Adobe Photoshop**: Professional standard, extensive tools
636
+ - **GIMP**: Free alternative to Photoshop
637
+ - **Adobe Illustrator**: Vector graphics, figure assembly
638
+ - **Inkscape**: Free vector graphics editor
639
+
640
+ ### Best Practices for Software Choice
641
+ - Use tools that produce vector output for graphs
642
+ - Learn one tool well rather than many superficially
643
+ - Script your figure generation for reproducibility
644
+ - Save original data files separately from figure files
645
+
646
+ ## Journal-Specific Figure and Table Requirements
647
+
648
+ ### Understanding Journal Expectations
649
+
650
+ **Different journals have vastly different requirements for figures and tables.** Before creating display items, always consult your target journal's author guidelines for specific requirements.
651
+
652
+ ### Common Journal-Specific Variations
653
+
654
+ | Aspect | Variation by Journal | Example Journals |
655
+ |--------|---------------------|------------------|
656
+ | **Number allowed** | 4-10 display items for research articles | Nature (4-6), PLOS ONE (unlimited), Science (4-5) |
657
+ | **File format** | TIFF, EPS, PDF, AI, or specific formats | Nature (EPS/PDF for line art), Cell (TIFF preferred) |
658
+ | **Resolution** | 300-1000 dpi depending on type | JAMA (300-600 dpi), Nature (300+ dpi) |
659
+ | **Color** | RGB vs. CMYK | Print journals: CMYK; Online: RGB |
660
+ | **Dimensions** | Single vs. double column widths | Nature (89mm or 183mm), Science (specific templates) |
661
+ | **Figure legends** | Length limits, specific format | Some journals: 150 word max per legend |
662
+ | **Table format** | Editable vs. image | Most prefer editable tables, not images |
663
+
664
+ ### Venue-Specific Requirements Summary
665
+
666
+ | Venue Type | Display Limit | Format | Resolution | Key Features |
667
+ |-----------|--------------|--------|------------|--------------|
668
+ | **Nature/Science** | 4-6 main | EPS/PDF/TIFF | 300+ dpi | Extended data allowed; multi-panel figures |
669
+ | **Medical journals** | 3-5 | TIFF/EPS | 300-600 dpi | CONSORT diagrams; conservative design |
670
+ | **PLOS ONE** | Unlimited | TIFF/EPS/PDF | 300+ dpi | Must work in grayscale |
671
+ | **ML conferences** | 4-6 in 8-page limit | PDF (vector preferred) | Print quality | Compact design; info-dense figures |
672
+
673
+ **ML Conference Figure Requirements:**
674
+
675
+ **NeurIPS/ICML/ICLR:**
676
+ - Figures count toward page limit (typically 8 pages including references)
677
+ - Vector graphics (PDF) preferred for plots
678
+ - High information density expected
679
+ - Supplementary material for additional figures
680
+ - LaTeX template provided (use neurips_2024.sty or equivalent)
681
+ - Figures must be legible when printed in grayscale
682
+
683
+ **Computer Vision (CVPR/ICCV/ECCV):**
684
+ - Qualitative results figures critical
685
+ - Side-by-side comparisons standard
686
+ - Must show failure cases
687
+ - Supplementary material for videos/additional examples
688
+ - Often 6-8 main figures in 8-page papers
689
+
690
+ **Key ML conference figure practices:**
691
+ - **Ablation studies**: Compact tables/plots showing component contributions
692
+ - **Architecture diagrams**: Clear, professional block diagrams
693
+ - **Performance plots**: Include error bars/confidence intervals
694
+ - **Qualitative examples**: Show diverse, representative samples
695
+ - **Comparison tables**: Concise, bold best results
696
+
697
+ ### Evaluation Criteria Across Venues
698
+
699
+ **What reviewers check:**
700
+ - **Necessity**: Each figure/table supports conclusions
701
+ - **Quality**: Professional appearance, sufficient resolution
702
+ - **Clarity**: Self-explanatory with captions; proper labeling
703
+ - **Statistics**: Error bars, sample sizes, significance indicators
704
+ - **Consistency**: Formatting uniform across display items
705
+
706
+ **Common rejection reasons:**
707
+ - Poor resolution or image quality
708
+ - Missing error bars or sample sizes
709
+ - Unclear or missing labels
710
+ - Too many figures (exceeds venue limits)
711
+ - Figures duplicate text information
712
+
713
+ **ML conference specific evaluation:**
714
+ - **Ablation studies**: Must demonstrate component contributions
715
+ - **Baselines**: Comparison with relevant prior work required
716
+ - **Error bars**: Confidence intervals/std dev expected
717
+ - **Architecture diagrams**: Must be clear and informative
718
+ - **Space efficiency**: Information density valued (page limits strict)
719
+
720
+ ### Caption/Legend Styles by Venue
721
+
722
+ | Venue Type | Style | Example Features |
723
+ |-----------|-------|------------------|
724
+ | **Nature/Science** | Concise | Brief; *P<0.05; minimal methods |
725
+ | **Medical** | Formal | Title case; 95% CIs; statistical tests spelled out |
726
+ | **PLOS/BMC** | Detailed | Complete sentences; all abbreviations defined |
727
+ | **ML conferences** | Technical | Architecture details; hyperparameters; dataset info |
728
+
729
+ **ML conference caption example:**
730
+ ```
731
+ Figure 1. Architecture of proposed model. (a) Encoder with 12 transformer layers.
732
+ (b) Attention visualization. (c) Performance vs. baseline on ImageNet (error bars:
733
+ 95% CI over 3 runs).
734
+ ```
735
+ - Technical precision
736
+ - Hyperparameters when relevant
737
+ - Dataset/experimental setup details
738
+ - Compact to save space
739
+
740
+ ### Quick Adaptation Guide
741
+
742
+ **When changing venues:**
743
+ - **Journal → ML conference**: Compress figures; increase information density; add hyperparameters to captions
744
+ - **ML conference → journal**: Expand captions; separate dense figures; add more methodological detail
745
+ - **Specialist → broad journal**: Simplify; add explanatory panels; define terms in captions
746
+ - **Broad → specialist journal**: Add technical detail; use field-standard plot types
747
+
748
+ ### Pre-Submission Figure/Table Checklist
749
+
750
+ **Technical (all venues):**
751
+ - [ ] Meets format requirements (PDF/EPS/TIFF)
752
+ - [ ] Sufficient resolution (300+ dpi)
753
+ - [ ] Fits venue dimensions/page limits
754
+ - [ ] Self-explanatory captions
755
+ - [ ] All symbols/abbreviations defined
756
+ - [ ] Error bars defined; sample sizes noted
757
+
758
+ **ML conferences additional:**
759
+ - [ ] Figures fit in page limit (8-9 pages typical)
760
+ - [ ] Comparison with baselines shown
761
+ - [ ] Ablation studies included
762
+ - [ ] Architecture diagram clear
763
+ - [ ] Legible in grayscale
764
+
765
+ ## Checklist for Final Review
766
+
767
+ ### Before Submission
768
+
769
+ **For every figure:**
770
+ - [ ] High enough resolution (300+ dpi)?
771
+ - [ ] Correct file format per journal requirements?
772
+ - [ ] Correct dimensions for journal (single/double column)?
773
+ - [ ] Meets journal's RGB/CMYK requirements?
774
+ - [ ] Self-explanatory caption with all abbreviations defined?
775
+ - [ ] Caption length within journal limits?
776
+ - [ ] All symbols/colors explained in caption or legend?
777
+ - [ ] Error bars included and defined?
778
+ - [ ] Sample sizes noted?
779
+ - [ ] Statistical tests described?
780
+ - [ ] Axes labeled with units?
781
+ - [ ] Readable text at final print size?
782
+ - [ ] Works in grayscale or color-blind friendly?
783
+ - [ ] Referenced in text in correct order?
784
+ - [ ] Style matches target journal's published figures?
785
+
786
+ **For every table:**
787
+ - [ ] Clear, descriptive title?
788
+ - [ ] Title capitalization matches journal style?
789
+ - [ ] Column headers include units?
790
+ - [ ] Appropriate numerical precision?
791
+ - [ ] Abbreviations defined in footnotes?
792
+ - [ ] Statistical methods explained?
793
+ - [ ] Sample sizes included?
794
+ - [ ] Consistent formatting with other tables?
795
+ - [ ] Editable format (not image)?
796
+ - [ ] Referenced in text in correct order?
797
+ - [ ] Formatting matches target journal's tables?
798
+
799
+ **Overall:**
800
+ - [ ] Number of display items within journal limits?
801
+ - [ ] Appropriate number of display items (~1 per 1000 words)?
802
+ - [ ] No duplication between text, figures, and tables?
803
+ - [ ] Consistent formatting across all display items?
804
+ - [ ] All display items necessary (each tells important part of story)?
805
+ - [ ] Visual style matches target journal?
806
+ - [ ] Quality comparable to published examples in journal?