| Title: | Create QC Checklists in Github Issues |
|---|---|
| Description: | A QC tool with 3 major functions: creation and management of QC log, creation and management of QC record, perform semi-automated QC tasks. |
| Authors: | Wes Cummings [aut, cre], Jenna Johnson [aut], Anne Zheng [aut], Janelle Lennie [ctb], Devin Pastoor [aut], Andrew Acker [aut] |
| Maintainer: | Wes Cummings <[email protected]> |
| License: | GPL (>= 3) + file LICENSE |
| Version: | 0.8.2 |
| Built: | 2026-06-03 09:28:56 UTC |
| Source: | https://github.com/a2-ai/ghqc.app |
Creates a ZIP archive containing selected files at specific commit versions. Handles file staging, directory structure options, and archive creation with proper error handling and user notifications. Now includes enhanced PDF support.
archive_selected_items( input, session, archive_name, root_dir, flatten = FALSE, archive_items = character(0), commit_df = NULL )archive_selected_items( input, session, archive_name, root_dir, flatten = FALSE, archive_items = character(0), commit_df = NULL )
input |
Reactive input object from Shiny session containing user selections. |
session |
Shiny session object for accessing namespaced inputs and notifications. |
archive_name |
Character string. The desired name/path for the archive file. |
root_dir |
Character string. The root directory path to use as the base for relative archive paths and working directory operations. |
flatten |
Logical. If TRUE, removes directory structure and places all files in the root of the archive. Default is FALSE. |
archive_items |
Character vector. File paths to be included in the archive. Default is empty character vector. |
commit_df |
Data frame containing commit information with columns: commit, file, and approved status. Used for generating archive metadata. Default is NULL. |
Character string (invisible). The absolute path to the created ZIP file, or NULL if no files were archived.
This function starts a Shiny application for archiving files.
ghqc_archive_app()ghqc_archive_app()
Starts a Shiny app and does not return any value.
This function provides an interface to assign one or more files for QC in the form of a GitHub Issue(s) within a GitHub Milestone, with options to assign a repository collaborator as the QCer and/or generate a checklist of suggested review tasks during QC.
ghqc_assign_app()ghqc_assign_app()
Starts a Shiny app and does not return any value.
This function allows a user to insert a comment into a ghqc GitHub Issue that displays changes in the version control information for the Issue’s corresponding file. By default, the comment displays both the original and current commits and hashes for the file. These versions are selected by the user. The comment can optionally display the file difference (“diff”) between the current and previous versions. These changes will likely be implementations of QC feedback.
ghqc_notify_app()ghqc_notify_app()
Starts a Shiny app and does not return any value.
This function allows the user to generate a QC Record for one or more Milestones created with the assign app.
ghqc_record_app()ghqc_record_app()
Starts a Shiny app and does not return any value.
set the repo that stores the ghqc info
ghqc_set_config_repo( repo_path = file.path("~/.local/share/ghqc", config_repo_name()) )ghqc_set_config_repo( repo_path = file.path("~/.local/share/ghqc", config_repo_name()) )
repo_path |
path to the git repo storing ghqc information |
View the status of one or more ghqc Issues and post QC Notification(s) and QC Approval(s)
ghqc_status_app(milestones = NULL)ghqc_status_app(milestones = NULL)
milestones |
The default set of one or more milestones to render in the QC Status table |
Starts a Shiny app and does not return any value.