Skip to content

Commit f3bbfe5

Browse files
Merge pull request #41 from Merck/limitations
Add current limitations to readme and revise installation guide
2 parents b770aeb + fa60b50 commit f3bbfe5

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,32 @@ in the control arm.
1414

1515
## Installation
1616

17-
Install the development version of wpgsd from GitHub:
17+
The easiest way to get wpgsd is to install from CRAN:
1818

1919
```r
20+
install.packages("wpgsd")
21+
```
22+
23+
Alternatively, to use a new feature or get a bug fix,
24+
you can install the development version of wpgsd from GitHub:
25+
26+
```r
27+
# install.packages("remotes")
2028
remotes::install_github("Merck/wpgsd")
2129
```
2230

31+
## Current limitations
32+
33+
There are some limitations that are currently being addressed.
34+
Please use the package with caution in production environments.
35+
36+
- The current implementation may have limitations when handling more
37+
complex scenarios beyond what has been demonstrated.
38+
- The API is subject to potential breaking changes as it is currently
39+
being reviewed and refactored.
40+
- Further validation is needed to ensure the reliability of the package.
41+
- More documentation is expected in the future releases.
42+
2343
## References
2444

2545
Anderson, K. M., Guo, Z., Zhao, J., & Sun, L. Z. (2022).

0 commit comments

Comments
 (0)