Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement/run app via package installation #123

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

Gotfrid
Copy link
Collaborator

@Gotfrid Gotfrid commented Nov 15, 2024

Issue

Closes #122

Description

This changes brings ability to run the app after installing the package - without cloning the repository.

Changes:

  • update `aNCA::run_app()
    • add ... to the signature to be able to pass arguments to shiny::runApp() such as host, port, etc
    • remove all import comments due to their redundant nature: the app should require all imports that are listed in the packages NAMESPACE file
    • call require() insider the function to load all required libraries
  • fixes:
    • move TLG data sample into inst folder, so that it can be properly loaded by the package
    • export some utility functions that are used by the app

Definition of Done

  • user can install the package from github via pak::pak("pharmaverse/aNCA")
  • user can run the app via aNCA::run_app()
  • README contains information on how to install & run the app
  • Package version is bumped

How to test

Single command to test the app via package installation (requires docker):

docker run --rm -it -p 3838:3838 rocker/r-ver:latest bash -c "apt update && apt install libcurl4-openssl-dev && Rscript -e \"install.packages('pak'); pak::pak('pharmaverse/aNCA@enhancement/run-app-via-package-installation')\" && Rscript -e \"aNCA::run_app(host='0.0.0.0',port=3838)\""

Alternatively, install the package in your environment via pak from this branch:

pak::pak('pharmaverse/aNCA@enhancement/run-app-via-package-installation')

Contributor checklist

  • Code passes lintr checks
  • Code passes all unit tests
  • New logic covered by unit tests
  • New logic is documented

Notes to reviewer

Please perform the functional testing rigorously - I only tested it with the slopes - area, that I am somewhat familiar with. There might be a chance that some packages were not properly put into the NAMESPACE, and due to that are not loaded in the app.

@Gotfrid Gotfrid linked an issue Nov 15, 2024 that may be closed by this pull request
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: run app via package installation
1 participant