Skip to content

Commit 304beb6

Browse files
committed
chore: Update README
Removing README.qmd, as it is no longer used
1 parent 44407a7 commit 304beb6

File tree

2 files changed

+51
-224
lines changed

2 files changed

+51
-224
lines changed

README.md

Lines changed: 51 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,67 @@
22

33
# Pmetrics <a href="https://lapkb.github.io/Pmetrics/"><img src="man/figures/Pmetrics_logo.png" align="right" height="100" width = "100" alt="Pmetrics" /></a>
44

5-
> [!WARNING]
6-
>
7-
> This is a development branch of Pmetrics using a new backend written
8-
> in Rust. The repository for the current stable release is
9-
> [LAPKB/Pmetrics](https://github.com/LAPKB/Pmetrics).
10-
11-
Thank you for your interest in Pmetrics, created by the [Laboratory of
5+
Thank you for your interest in `Pmetrics`, created by the [Laboratory of
126
Applied Pharmacokinetics and Bioinformatics](http://www.lapk.org).
13-
Pmetrics is a library package for R to perform non-parametric and
7+
`Pmetrics` is a library package for R to perform non-parametric and
148
parametric pharmacokinetic-pharmacodynamic population and individual
159
modeling and simulation. It is primarily designed for pharmacometric
1610
researchers.
1711

18-
Pmetrics is based on over 40 years of research by our laboratory and is
19-
the most mature non-parametric method available. Nevertheless, Pmetrics
12+
`Pmetrics` is based on over 40 years of research by our laboratory and is
13+
the most mature non-parametric method available. Nevertheless, `Pmetrics`
2014
is dynamically evolving. Best of all, it is SHAREWARE with only a
2115
suggested donation.
2216

23-
## Source code
24-
25-
The open source code for the Pmetrics R package is hosted here on
26-
Github. LAPKB has developed two other packages,
27-
[PMcore](https://github.com/LAPKB/PMcore) and
28-
[pharmsol](https://github.com/LAPKB/pharmsol), which implement the core
29-
algorithms used by Pmetrics. These packages are also open source and
30-
available on Github.
3117

3218
## Installation
3319

34-
To install and use Pmetrics, you will need **R**, **Rust**, and the
35-
**Pmetrics** package appropriate for your system.
20+
### R (required)
21+
22+
You can download and install [R](https://r-project.org) from the
23+
[Comprehensive R Archive Network (CRAN)](https://cran.r-project.org/).
24+
25+
### Rust (required)
26+
27+
The simulation engine for `Pmetrics` is written in `Rust`, which is required to fit models.
28+
29+
Follow the instructions on the [Rust
30+
website](https://www.rust-lang.org/tools/install) to install Rust on
31+
your system.
32+
33+
### Pmetrics
34+
35+
`Pmetrics` is distributed on [r-universe](https://lapkb.r-universe.dev/Pmetrics), and built for Windows, MacOS, and Linux. To install, you must specify `r-universe` as the repository using
36+
37+
```r
38+
install.packages("Pmetrics", repos = "https://lapkb.r-universe.dev")
39+
```
40+
41+
For updating the package and for easier future installations, you can run the following command
42+
to add the `r-universe` repository to your `R.profile`
3643

37-
<a href="https://r-project.org"><img src="man/figures/Rlogo.png" align="left" height="40" width="40" alt="R" /></a><br><br>
38-
You can download and install **R** from the [Comprehensive R Archive
39-
Network (CRAN)](https://cran.r-project.org/). In addition, we *strongly*
40-
recommend a third-party integrated development environment (IDE) to use
41-
R and Pmetrics rather than the rudimentary IDE that comes with R. We use
42-
all the IDEs below when developing and working with Pmetrics.
44+
```r
45+
write('options(repos = c(CRAN = "https://cloud.r-project.org", LAPKB = "https://lapkb.r-universe.dev"))', "~/.Rprofile", append = TRUE)
46+
```
47+
48+
With this setup, you can install or update Pmetrics using the
49+
standard command `install.packages("Pmetrics")` without specifying
50+
the repository each time.
51+
52+
53+
### IDE (optional)
54+
55+
In addition, we *strongly* recommend a third-party integrated
56+
development environment (IDE) to use R and Pmetrics rather than the
57+
rudimentary IDE that comes with R. We use all the IDEs below when
58+
developing and working with Pmetrics.
4359

4460
- [RStudio](https://posit.co/download/rstudio-desktop/) is the oldest
4561
and most stable IDE, developed by [Posit](https://posit.co). Most
4662
users who only program in R use Rstudio. It has a simple interface
4763
with many R-specific buttons and menus. It is relatively easy to learn
4864
and use, but does not support other programming languages.
65+
4966
- [Positron](https://positron.posit.co) is a newer alternative also from
5067
Posit. Posit are now mostly developing Positron rather than Rstudio.
5168
Positron primarily supports users who work in R and Python. However,
@@ -56,121 +73,25 @@ all the IDEs below when developing and working with Pmetrics.
5673
Rstudio, but has a steeper learning curve and currently fewer
5774
R-specific buttons and menus. VS Code users will find Positron
5875
familiar.
76+
5977
- [VS Code](https://code.visualstudio.com) itself can be used for R, but
6078
it is best suited for experienced coders who also use other
6179
programming languages.
6280

63-
<a href="https://rust-lang.org"><img src="man/figures/rust-logo-64x64.png" align="left" height="40" width = "40" alt="Rust" /></a><br><br>
64-
**Rust** is the language used by pharmsol for the backend of Pmetrics
65-
and all the heavy “number crunching”. Rust is modern, fast, reliable,
66-
widely used, and extremely well supported. It works on all major
67-
operating systems.
68-
69-
Follow the instructions on the [Rust
70-
website](https://www.rust-lang.org/tools/install) to install Rust on
71-
your system.
72-
73-
<img src="man/figures/Pmetrics_logo.png" align="left" height="40" width = "40" alt="Pmetrics" /><br><br>
74-
The compiled versions of **Pmetrics** for MacOS, Windows and Linux are
75-
hosted on [r-universe](https://lapkb.r-universe.dev/Pmetrics). Follow
76-
these easy steps to install the correct version for your system.
77-
78-
1. Add the LAPKB r-universe repository to your list of repositories by
79-
adding this code to your `.Rprofile` script, which ensures that R
80-
will always include the LAPKB repository when installing or updating
81-
packages, even after you restart or update R.
82-
83-
``` r
84-
options(repos = c(
85-
CRAN = "https://cloud.r-project.org",
86-
LAPKB = "https://lapkb.r-universe.dev"
87-
))
88-
```
89-
90-
If you dont have an `.Rprofile` script, you can create one in your
91-
home directory. This only needs to be done once.
92-
93-
<details>
94-
95-
<summary>
96-
97-
Mac
98-
99-
</summary>
100-
101-
You can create or edit the `.Rprofile` file using TextEdit or any
102-
text editor. Make sure to save it as a plain text file named
103-
`.Rprofile` in your home directory, i.e.,
104-
`/Users/yourusername/.Rprofile`. Do not add a `.txt` extension. To
105-
open/edit your `.Rprofile` later, type `open -e ~/.Rprofile` in the
106-
Terminal.
107-
108-
</details>
109-
110-
<details>
111-
112-
<summary>
113-
114-
Windows
115-
116-
</summary>
117-
118-
You can create or edit the `.Rprofile` file using Notepad or any
119-
text editor. Make sure to save it as a plain text file named
120-
`.Rprofile` in your home directory, i.e.,
121-
`C:\Users\yourusername\.Rprofile`. Do not add a `.txt` extension. To
122-
open/edit your `.Rprofile` later, type
123-
`notepad %USERPROFILE%\.Rprofile` in the Command Prompt.
124-
125-
</details>
126-
127-
<details>
128-
129-
<summary>
130-
131-
Linux
132-
133-
</summary>
134-
135-
You can create or edit the `.Rprofile` file using any text editor,
136-
such as `nano` or `vim`. Make sure to save it as a plain text file
137-
named `.Rprofile` in your home directory, i.e.,
138-
`/home/yourusername/.Rprofile`. To open/edit your `.Rprofile` later,
139-
type `nano ~/.Rprofile` or `vim ~/.Rprofile` in the terminal.
140-
141-
</details>
142-
143-
2. After you have run the above command once, you can install or update
144-
previously installed Pmetrics by running this command in R:
145-
146-
``` r
147-
install.packages("Pmetrics")
148-
```
149-
150-
This command is the same as for any other R package hosted on CRAN.
151-
By having the LAPKB repository in your list of repositories, R will
152-
automatically find and install/update the correct version of
153-
Pmetrics for your system.
154-
155-
<details>
15681

157-
<summary>
82+
## Related projects
15883

159-
What if I couldnt add the LAPKB repository to my .Rprofile?
84+
The LAPKB has developed two packages in `Rust` to power `Pmetrics`.
16085

161-
</summary>
86+
[`pharmsol`](https://github.com/LAPKB/pharmsol) is a Rust library for defining and solving pharmacokinetic models.
16287

163-
You can still install Pmetrics by specifying the repository directly
164-
in the `install.packages` function like this:
88+
[`PMcore`](https://github.com/LAPKB/PMcore) depends on `pharmsol` to fit models to data, and implements the different algorithms which are made available in `Pmetrics`.
16589

166-
``` r
167-
install.packages("Pmetrics", repos = "https://lapkb.r-universe.dev")
168-
```
90+
Pmetrics and the code that powers it is provided as open-source code.
16991

170-
However, you will need to include the `repos` argument each time you
171-
want to install or update Pmetrics.
92+
## Contributing
17293

173-
</details>
94+
We welcome contributions in the form of feature requests, raising issues, or writing code.
17495

17596
## Documentation
17697

README.qmd

Lines changed: 0 additions & 94 deletions
This file was deleted.

0 commit comments

Comments
 (0)