Skip to content

Commit

Permalink
Added function to get package version information
Browse files Browse the repository at this point in the history
  • Loading branch information
john-harrold committed Aug 1, 2023
1 parent 1829514 commit 84d5f3f
Show file tree
Hide file tree
Showing 44 changed files with 482 additions and 138 deletions.
11 changes: 7 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@ knitr::opts_chunk$set(

The goal of `{ruminate}` is to facilitate exploration of pharmacometrics data. This is done by creating a Shiny interface to different tools for data transformation (`{dplyr}` and `{tidyr}`), plotting (`{ggplot2}`), and noncompartmental analysis (`{PKNCA}`). These results can be reported in Excel, Word or PowerPoint. The state of the app can be saved and loaded at a later date. When saved, a script is generated to reproduce the different actions in the Shiny interface.

# Installation
# Deployed example in the cloud

You can point your web browser to [runrumiate.ubiquity.tools](https://runruminate.ubiquity.tools) and try the development version of ruminate. Keep in mind this is a public server. No data is tracked or kept, but it is open to the public. So be careful about uploading confidential data. Also know this is a single instance and if many people are using it at once it can be slow.

# Local installation

<!---
You can install the released version of ``rumiante`` from [CRAN](https://cran.r-project.org/package=ruminate) with:
Expand All @@ -54,16 +59,14 @@ devtools::install_github("john-harrold/ruminate", dependencies=TRUE)

Note that because `{ruminate}` depends on `{formods}` and `{onbrand}` you will need to first install the development versions of `{onbrand}` and `{formods}`.

# Getting started

## Running in RStudio

``` r
library(ruminate)
ruminate()
```

## Running in a Docker container
# Running in a Docker container

Note this uses an `x86` image. So it will only work on Intel or AMD cpus. This means that you wont get very far with an M1 mac. If you want, you can download the Docker file [here](https://raw.githubusercontent.com/john-harrold/ruminate/main/inst/docker/local_container). This will build the docker image from the repository on GitHub.

Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,20 @@ in Excel, Word or PowerPoint. The state of the app can be saved and
loaded at a later date. When saved, a script is generated to reproduce
the different actions in the Shiny interface.

# Installation
# Deployed example in the cloud

You can point your web browser to
[runrumiate.ubiquity.tools](https://runruminate.ubiquity.tools) and try
the development version of ruminate. Keep in mind this is a public
server. No data is tracked or kept, but it is open to the public. So be
careful about uploading confidential data. Also know this is a single
instance and if many people are using it at once it can be slow.

# Local installation

<!---
You can install the released version of ``rumiante`` from [CRAN](https://cran.r-project.org/package=ruminate) with:
``` r
&#10;``` r
install.packages("ruminate")
```
--->
Expand All @@ -52,16 +60,14 @@ Note that because `{ruminate}` depends on `{formods}` and `{onbrand}`
you will need to first install the development versions of `{onbrand}`
and `{formods}`.

# Getting started

## Running in RStudio

``` r
library(ruminate)
ruminate()
```

## Running in a Docker container
# Running in a Docker container

Note this uses an `x86` image. So it will only work on Intel or AMD
cpus. This means that you wont get very far with an M1 mac. If you want,
Expand Down
3 changes: 3 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ reference:
# - starts_with("NCA_")
navbar:
left:
- text: "Try Online"
icon: fas fa-cloud
href: https://runruminate.ubiquity.tools/
- text: "Tutorial"
icon: fas fa-chalkboard-teacher
menu:
Expand Down
7 changes: 7 additions & 0 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion docs/articles/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions docs/articles/noncompartmental_analysis.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 24 additions & 17 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pandoc: 2.19.2
pandoc: 3.1.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles:
noncompartmental_analysis: noncompartmental_analysis.html
last_built: 2023-07-25T02:38Z
last_built: 2023-07-31T20:13Z

Loading

0 comments on commit 84d5f3f

Please sign in to comment.