Skip to content

Commit

Permalink
Merge pull request #41 from Merck/limitations
Browse files Browse the repository at this point in the history
Add current limitations to readme and revise installation guide
  • Loading branch information
LittleBeannie authored Apr 25, 2024
2 parents b770aeb + fa60b50 commit f3bbfe5
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,32 @@ in the control arm.

## Installation

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

```r
install.packages("wpgsd")
```

Alternatively, to use a new feature or get a bug fix,
you can install the development version of wpgsd from GitHub:

```r
# install.packages("remotes")
remotes::install_github("Merck/wpgsd")
```

## Current limitations

There are some limitations that are currently being addressed.
Please use the package with caution in production environments.

- The current implementation may have limitations when handling more
complex scenarios beyond what has been demonstrated.
- The API is subject to potential breaking changes as it is currently
being reviewed and refactored.
- Further validation is needed to ensure the reliability of the package.
- More documentation is expected in the future releases.

## References

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

0 comments on commit f3bbfe5

Please sign in to comment.