Skip to content
This repository has been archived by the owner on Aug 9, 2021. It is now read-only.

mong/qmongr

Repository files navigation

qmongr

Version R build status Codecov test coverage GitHub open issues License: GPL v3 Doc

The goal of qmongr is to ...

Installation

You can install the latest released version of qmongr from github with:

remotes::install_github("mong/qmongr@*release")

Usage

qmongr purpose is to provide a web application. From an R command promt do:

library(qmongr)
run_app()

Docker

This R package can be added to a docker image together with all R and system dependencies needed to run the the qmongr web application from any docker host.

Build

Since the qmongr R package is to be installed into the image please make sure to build the source tarball first. From a system command terminal navigate into the qmongr-directory and run:

R CMD build .

Then, build the docker image:

docker build -t qmongr .

Run

To run the docker container from a system command terminal do:

docker run -p 3838:3838 qmongr

Then, open a web browser window and navigate to your localhost at port 3838 to use the qmongr web application.

To stop the docker container hit Ctrl + c in the system comman terminal.

Develop

Each time the source of the qmongr R package is updated and you want to see the result by running the docker container please make sure also to repeat the Build step above before runnig the container.

You may also use the docker development environment provided:

docker-compose up

This contains three containers: a database server, an admin interface to the database and the R-Studio IDE. Assuming that a database dump (e.g. imongr_db_dump.sql.gz) exists in the root of this project the database will also be populated by relevant data as the containers are started.

Ethics

Please note that the 'qmongr' project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.