#27 draft documentation vignettes #81
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation vignettes for the OSPSuite.QualificationPlanEditor package, focusing on workflows for converting qualification plans between JSON and Excel formats. The documentation includes a main "Get Started" guide and several detailed articles covering specific use cases.
Key changes:
- Added structured documentation with workflow descriptions and examples
- Integrated Excel file display functionality for HTML documentation
- Added example files (JSON and Excel) to support the documentation
- Configured pkgdown for documentation website generation
Reviewed changes
Copilot reviewed 11 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
vignettes/ospsuite-qualificationplaneditor.Rmd |
Updated main vignette with workflow overview, reorganized sections, and cross-references to detailed articles |
vignettes/articles/update-qualification.Rmd |
New article demonstrating how to update evaluations in an existing qualification plan |
vignettes/articles/snapshot-qualification.Rmd |
New article showing how to add a project snapshot to an existing qualification plan |
vignettes/articles/no-qualification.Rmd |
New article explaining how to create a qualification plan from a snapshot without an existing plan |
vignettes/articles/excel-template.Rmd |
New article documenting the Excel template structure, color conventions, and editing guidelines |
vignettes/articles/qualification_ugt.xlsx |
Example Excel file (binary) for UGT qualification plan |
vignettes/articles/qualification_ugt.json |
Example JSON qualification plan file for UGT-mediated DDI |
inst/excel-display.R |
Helper functions to display Excel files with styling in HTML documentation |
_pkgdown.yml |
Configuration file for pkgdown website generation |
DESCRIPTION |
Added documentation-related dependencies (gt, tidyxl) and website configuration |
.gitignore |
Added docs folder to ignore list |
.Rbuildignore |
Added pkgdown and documentation-related patterns to build ignore list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 15 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 15 changed files in this pull request and generated 18 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@pchelle Please check and resolve (or fix) open Copilot comments. |
2 participants
This PR leverages within
displayExcel()thegtandtidyxlpackages as well as html tabsets to render interactively the content of Excel workbooks.This allows users to have a direct assessment of the workbook on actual examples as they can click on the tabs to review each sheet of the exported Excel file.
Here is a snapshot of such rendering: