Package: ghqc 0.2.0

Wes Cummings

ghqc: Manage QC via GitHub Issues using Shiny Apps

This package launches 3 ghqc applications as background jobs to aid the QC process through the use of shiny apps. It also contains aides to maintain the proper setup of the ecosystem. Namely, it will aid in the installation of ghqc.app and its dependendencies into an isolated directory as to not interfere with the project being QCed.

Authors:Anne Zheng [aut], Jenna Johnson [aut], Janelle Lennie [ctb], Devin Pastoor [aut], Wes Cummings [aut, cre]

ghqc_0.2.0.tar.gz
ghqc_0.2.0.zip(r-4.5)ghqc_0.2.0.zip(r-4.4)ghqc_0.2.0.zip(r-4.3)
ghqc_0.2.0.tgz(r-4.4-any)ghqc_0.2.0.tgz(r-4.3-any)
ghqc_0.2.0.tar.gz(r-4.5-noble)ghqc_0.2.0.tar.gz(r-4.4-noble)
ghqc_0.2.0.tgz(r-4.4-emscripten)ghqc_0.2.0.tgz(r-4.3-emscripten)
ghqc.pdf |ghqc.html
ghqc/json (API)
NEWS

# Install 'ghqc' in R:
install.packages('ghqc', repos = c('https://a2-ai.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/a2-ai/ghqc/issues

On CRAN:

2.70 score 3 scripts 15 exports 16 dependencies

Last updated 12 hours agofrom:ade0d77ff3. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 22 2024
R-4.5-winOKNov 22 2024
R-4.5-linuxOKNov 22 2024
R-4.4-winOKNov 22 2024
R-4.4-macOKNov 22 2024
R-4.3-winOKNov 22 2024
R-4.3-macOKNov 22 2024

Exports:check_ghqc_configurationcheck_ghqcapp_dependenciesdownload_ghqc_configurationghqc_assign_appghqc_config_pathghqc_libpathghqc_record_appghqc_resolve_appghqc_sitrepinstall_ghqcapp_dependencieslink_ghqcapp_dependenciesremove_ghqc_configurationremove_ghqc_dependenciessetup_ghqcsetup_ghqc_renviron

Dependencies:clifastmapfsgluehttpuvlatermagrittrprocessxpromisespsR6Rcpprlangrstudioapiwithryaml

Readme and manuals

Help Manual

Help pageTopics
Check the content of the downloaded ghqc custom configuration repository and download any updates neededcheck_ghqc_configuration
Check the installed/linked packages in 'lib_path' against the recommended ghqc.app dependency package versioncheck_ghqcapp_dependencies
Download the custom configuration repository as set in environmental variable 'GHQC_CONFIG_REPO'download_ghqc_configuration
Assign file(s) to be reviewed for QCghqc_assign_app
The default install location for the ghqc custom configuration repositoryghqc_config_path
The default install location for the ghqc package and its dependencies. If it does not exist, it will be created.ghqc_libpath
Generate a QC Record for one or more Milestonesghqc_record_app
Comment in an Issue to display file changes during QCghqc_resolve_app
Situation report for ghqc set-upghqc_sitrep
install ghqc.app's dependencies into an isolated libraryinstall_ghqcapp_dependencies
Shiny is "ready" if the download.file is able to serve the starting html, at this point, we will try to hit the shiny app and see if it downloadsis_shiny_ready
symlink previously installed package library containing all ghqc.app dependencies to an isolated package librarylink_ghqcapp_dependencies
Remove the downloaded custom configuration repository from 'config_path'remove_ghqc_configuration
Remove all content in the specified lib path. Optionally removes the cache as well.remove_ghqc_dependencies
Interactive function to set up the ghqc environment, including writing to the .Renviron, custom configuration repository download, and ghqc.app dependency installation/linking, for use of the ghqc application suitesetup_ghqc
helper function to setup/write Renviron file for ghqcsetup_ghqc_renviron