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.

Sign up for GitHub

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

Add current limitations to readme and revise installation guide #41

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Add current limitations to readme and revise installation guide #41

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0d45eb
Add current limitations to readme and revise installation guide
nanxstats Apr 16, 2024
fa60b50
Revise limitations list
nanxstats Apr 25, 2024
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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
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