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

update README.Rmd #1469

Merged
merged 3 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ knitr::opts_chunk$set(
# OSPSuite-R

<!-- badges: start -->
[![R-CMD-check](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R/branch/develop/graph/badge.svg)](https://app.codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R?branch=develop)
[![](https://img.shields.io/github/actions/workflow/status/Open-Systems-Pharmacology/OSPSuite-R/main-workflow.yaml?branch=main&label=Build
)](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/actions/workflows/main-workflow.yaml)
[![Codecov test coverage](https://codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R?branch=main)
<!-- badges: end -->

# Overview
Expand Down Expand Up @@ -75,7 +76,7 @@ following order:
# Installation

The **ospsuite** package is compatible with R version 4.x.x and can be used on
[Windows](#on-windows) and [Linux](#on-linux) operating systems.
[Windows](#on-windows) and [Linux (Ubuntu)](#on-linux) operating systems.

`ospsuite` is not available on CRAN and also depends on packages from the OSP ecosystem
that are not available on CRAN. Please follow the instructions below to install
Expand All @@ -89,7 +90,7 @@ the packages and all required dependencies.
The package requires additional software installations:


- Latest Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019 available [here](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
- Latest Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019 and 2022 available [here](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
- .NET 8 runtime available [here](https://dotnet.microsoft.com/download/dotnet/8.0/runtime).

**NB**: These pre-requisites are already installed if the OSP Suite was installed before.
Expand Down Expand Up @@ -190,17 +191,15 @@ install.packages(pathToOSPSuite.zip, repos = NULL)
## On Linux

The **ospsuite** package has been tested under Linux distribution
**Ubuntu 22**. Installation
**Ubuntu 22.04**. Installation
under Linux requires several prerequisites, the detailed instructions
can be found in the Wiki:

- [Setup OSPSuite-R on
CentOS](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/wiki/Setup-ospsuite-R-on-CentOS7)
- [Setup OSPSuite-R on
Ubuntu](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/wiki/Setup-ospsuite-R-on-Ubuntu)

For other Linux distributions Docker containers can be used (Dockerfiles
based on CentOS 7 and Ubuntu 18 are available under
For other Linux distributions Docker containers can be used (Docker container
based on Ubuntu 22 is available under
<https://github.com/Open-Systems-Pharmacology/OSPSuite-R/releases>)

## Build from source
Expand All @@ -210,7 +209,7 @@ You can clone the GIT repository and build the package from source.
### How to update the libraries?

The `{ospsuite}` package requires some shared libraries to get access to PK-Sim
functionality. To get the latest libraries(dll on Windows or so on Linux), run
functionality. To get the latest libraries(**.dll** on Windows or **.so** on Linux), run
the script file `update_core_files.R' provided with this package.


Expand Down
61 changes: 29 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

<!-- badges: start -->

[![R-CMD-check](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/actions/workflows/R-CMD-check.yaml)
[![](https://img.shields.io/github/actions/workflow/status/Open-Systems-Pharmacology/OSPSuite-R/main-workflow.yaml?branch=main&label=Build)](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/actions/workflows/main-workflow.yaml)
[![Codecov test
coverage](https://codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R/branch/develop/graph/badge.svg)](https://app.codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R?branch=develop)
coverage](https://codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Open-Systems-Pharmacology/OSPSuite-R?branch=main)
<!-- badges: end -->

# Overview
Expand Down Expand Up @@ -64,7 +64,8 @@ following order:
# Installation

The **ospsuite** package is compatible with R version 4.x.x and can be
used on [Windows](#on-windows) and [Linux](#on-linux) operating systems.
used on [Windows](#on-windows) and [Linux (Ubuntu)](#on-linux) operating
systems.

`ospsuite` is not available on CRAN and also depends on packages from
the OSP ecosystem that are not available on CRAN. Please follow the
Expand All @@ -78,7 +79,7 @@ dependencies.
The package requires additional software installations:

- Latest Microsoft Visual C++ Redistributable for Visual Studio 2015,
2017 and 2019 available
2017, 2019 and 2022 available
[here](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
- .NET 8 runtime available
[here](https://dotnet.microsoft.com/download/dotnet/8.0/runtime).
Expand Down Expand Up @@ -115,25 +116,23 @@ files provided with the
When installing from such files, the CRAN dependencies need to be
installed manually first.

``` r
# Install dependencies (e.g. R6) which are on CRAN
install.packages("data.table")
install.packages("dplyr")
install.packages("ggplot2")
install.packages("ggtext")
install.packages("jsonlite")
install.packages("lifecycle")
install.packages("openxlsx")
install.packages("patchwork")
install.packages("purrr")
install.packages("R6")
install.packages("rClr")
install.packages("readr")
install.packages("rlang")
install.packages("stringr")
install.packages("tidyr")
install.packages("xml2")
```
#> Warning: package 'pacman' was built under R version 4.2.3
# Install dependencies (e.g. R6) which are on CRAN
install.packages("data.table")
install.packages("dplyr")
install.packages("ggplot2")
install.packages("ggtext")
install.packages("jsonlite")
install.packages("lifecycle")
install.packages("openxlsx")
install.packages("patchwork")
install.packages("purrr")
install.packages("R6")
install.packages("readr")
install.packages("rlang")
install.packages("stringr")
install.packages("tidyr")
install.packages("xml2")

#### Install non-CRAN dependencies

Expand Down Expand Up @@ -176,16 +175,14 @@ install.packages(pathToOSPSuite.zip, repos = NULL)
## On Linux

The **ospsuite** package has been tested under Linux distribution
**Ubuntu 22**. Installation under Linux requires several prerequisites,
the detailed instructions can be found in the Wiki:
**Ubuntu 22.04**. Installation under Linux requires several
prerequisites, the detailed instructions can be found in the Wiki:

- [Setup OSPSuite-R on
CentOS](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/wiki/Setup-ospsuite-R-on-CentOS7)
- [Setup OSPSuite-R on
Ubuntu](https://github.com/Open-Systems-Pharmacology/OSPSuite-R/wiki/Setup-ospsuite-R-on-Ubuntu)

For other Linux distributions Docker containers can be used (Dockerfiles
based on CentOS 7 and Ubuntu 18 are available under
For other Linux distributions Docker containers can be used (Docker
container based on Ubuntu 22 is available under
<https://github.com/Open-Systems-Pharmacology/OSPSuite-R/releases>)

## Build from source
Expand All @@ -195,9 +192,9 @@ You can clone the GIT repository and build the package from source.
### How to update the libraries?

The `{ospsuite}` package requires some shared libraries to get access to
PK-Sim functionality. To get the latest libraries(dll on Windows or so
on Linux), run the script file \`update_core_files.R’ provided with this
package.
PK-Sim functionality. To get the latest libraries(**.dll** on Windows or
**.so** on Linux), run the script file \`update_core_files.R’ provided
with this package.

# Known issues

Expand Down
Loading