-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# omgee | ||
This R package provides an implementation of the GEE method for estimating multinomial probabilties for clustered data, for independent and exchangeable correlation structure. For more details about the methodology see [citation]. | ||
|
||
## Installation | ||
There are a few methods available for installing the package. You need to have the `devtools` package installed to use these methods: | ||
```r | ||
> install.packages('devtools') | ||
``` | ||
|
||
### Using GitHub | ||
Use the `install_github` method from devtools to install directly from this repository: | ||
```r | ||
> devtools::install_github('https://github.com/Express50/omgee') | ||
``` | ||
|
||
### Using pre-built tar file | ||
Download the latest released .tar.gz file from the [Releases](https://github.com/Express50/omgee/releases) page into an empty folder. Then, navigate to the location of the file in your command line, and run the following from an R shell: | ||
```r | ||
> devtools::install('.', dependencies=TRUE) | ||
``` | ||
|
||
## Building | ||
You can also build the code yourself by cloning the repository and using `R CMD BUILD`. Make sure to install the `rootSolve` dependecy before installing `omgee`, by running `install.packages('rootSolve')` | ||
```sh | ||
> git clone https://github.com/Express50/omgee omgee | ||
> R CMD build omgee | ||
> R CMD INSTALL omgee_1.0.tar.gz | ||
``` |