In zhenkewu/baker: "Nested Partially Latent Class Models"
library(badger)
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
baker: Bayesian Analysis Kit for Etiology Research
An R Package for Fitting Bayesian Nested Partially Latent Class Models
r badger::badge_cran_release("baker", "green")
r badger::badge_cran_download("baker", "grand-total", "green")
r badger::badge_cran_download("baker", "last-month", "green")
r badger::badge_cran_download("baker", "last-week", "green")
r badger::badge_devel("zhenkewu/baker", "blue")
r badger::badge_lifecycle("maturing", "blue")
Maintainer: Zhenke Wu, zhenkewu@umich.edu
Source Code: Please click here for source code on GitHub.
Issues: Please click here to report reproducible issues.
Vignette: Please click here to read the latest long-version vignette; a short version can be found here.
Package website: Please click here for a website generated by pkgdown, which contains html format of the package manual ("Refence").
References: If you are using baker for population and individual estimation from case-control data, please cite the following papers:
| | Citation |
| ------------- | ------------- |
| partially Latent Class Models (pLCM) | Wu, Z., Deloria-Knoll, M., Hammitt, L. L., Zeger, S. L. and the Pneumonia Etiology Research for Child Health Core Team (2016), Partially latent class models for case–control studies of childhood pneumonia aetiology. J. R. Stat. Soc. C, 65: 97–114. r badger::badge_doi("10.1111/rssc.12101", "yellow")|
| nested pLCM | Wu, Z., Deloria-Knoll, M., Zeger, S.L.; Nested partially latent class models for dependent binary data; estimating disease etiology. Biostatistics 2017; 18 (2): 200-213. r badger::badge_doi("10.1093/biostatistics/kxw037", "yellow")|
| nested pLCM regression | Wu, Z., Chen, I (2021). Probabilistic Cause-of-disease Assignment using Case-control Diagnostic Tests: A Hierarchical Bayesian Approach. Statistics in Medicine 40(4):823-841. r badger::badge_doi("10.1002/sim.8804", "yellow")|
| Application |Maria Deloria Knoll, Wei Fu, Qiyuan Shi, Christine Prosperi, Zhenke Wu, Laura L. Hammitt, Daniel R. Feikin, Henry C. Baggett, Stephen R.C. Howie, J. Anthony G. Scott, David R. Murdoch, Shabir A. Madhi, Donald M. Thea, W. Abdullah Brooks, Karen L. Kotloff, Mengying Li, Daniel E. Park, Wenyi Lin, Orin S. Levine, Katherine L. O’Brien, Scott L. Zeger; Bayesian Estimation of Pneumonia Etiology: Epidemiologic Considerations and Applications to the Pneumonia Etiology Research for Child Health Study, Clinical Infectious Diseases, Volume 64, Issue suppl_3, 15 June 2017, Pages S213–S227 r badger::badge_doi("10.1093/cid/cix144", "yellow")|
| Primary PERCH Analysis | The PERCH Study Group (2019). Aetiology of severe hospitalized pneumonia in HIV-uninfected children from Africa and Asia: the Pneumonia Aetiology Research for Child Health (PERCH) Case-Control Study. The Lancet 394(10200): 757-779. r badger::badge_doi("10.1016/S0140-6736(19)30721-4", "yellow")|
| Software paper | Chen I, Shi Q, Zeger SL, Wu Z (2022+) baker: An R package for Nested Partially-Latent Class Models. r badge_custom("arxiv", "preprint", "red", "https://arxiv.org/abs/2202.11778") r badge_custom("vignette", "workflow", "blue", "https://zhenkewu.com/assets/html/baker_vignette.html")|
There are a number of scientific papers on global health and infectious diseases
that have used the model and some the software (in its earlier versions). Some notable
examples are listed below:
| | Notable References using baker (model and/or software)|
| ------------- | ------------- |
|1 |Kubale et al. (2023). Etiology of acute lower respiratory illness hospitalizations among infants in four countries. Open Forum Infectious Diseases, ofad580. r badger::badge_doi("10.1093/ofid/ofad580", "green")
|2 |Saha SK et al. (2018). Causes and incidence of community-acquired serious infections among young children in south Asia (ANISA): an observational cohort study. The Lancet 392(10142):145-159. r badger::badge_doi("10.1016/S0140-6736(18)31127-9","green")
Table of content
- 1. Installation
- 2. Vignettes
- 3. Graphical User Interface (GUI)
- 4. Analytic Goal
- 5. Comparison to Other Existing Solutions
- 6. Details
- 7. Platform
- 8. Connect R to JAGS on Unix systems or OSX
- 9. Submit Jobs to Computing Cluster via a shell script
- 10. Connect R to JAGS on Windows
- 11. Example Datasets
Installation
--------------
wzxhzdk:1
Note:
* run `install.packages("pbkrtest")` for `R(>=3.2.3)` if this
package is reported as missing.
* Windows User: use `devtools::install_github("zhenkewu/baker",INSTALL_opts=c("--no-multiarch"))` instead if you see an error message `ERROR: loading failed for 'i386'` (Thanks Chrissy!).
Vignettes
-------------
wzxhzdk:2
Graphical User Interface (GUI)
--------------------------------
wzxhzdk:3
For developers interested in low-level details, here is a pretty awesome [visualization](https://stackoverflow.com/questions/44143110/visualizing-r-function-dependencies)
of the function dependencies within the package:
wzxhzdk:4
You will get a dynamic figure. A snapshot is below:
Analytic Goal
-------------------------------------
- To study disease etiology from case-control data from multiple sources that have measurement errors. If you are interested in estimating the population etiology pie (fraction), and the probability of each cause for individual case, try `baker`.
Comparison to Other Existing Solutions
------------------------------------------------
- Acknowledges various levels of measurement errors and combines multiple sources
of data for optimal disease diagnosis.
- Main function: `nplcm()` that fits the model with or without covariates.
Details
-------------------------------------
1. Implements hierarchical Bayesian models to infer disease etiology for multivariate binary data. The package builds in functionalities for data cleaning, exploratory data analyses, model specification, model estimation, visualization and model diagnostics and comparisons, catalyzing vital effective communications between analysts and practicing clinicians.
2. `baker` has implemented models for dependent measurements given disease status, regression analyses of etiology, multiple imperfect measurements, different priors for true positive rates among cases with differential measurement characteristics, and multiple-pathogen etiology.
3. Scientists in [Pneumonia Etiology Research for Child Health](https://www.jhsph.edu/ivac/) (PERCH) study usually refer to the etiology distribution as "*population etiology pie*" and "*individual etiology pie*" for their compositional nature, hence the name of the package.
Platform
---------
- The `baker` package is compatible with OSX, Linux and Windows systems, each requiring a slightly different setup as described below. If you need to speed up the installation and analysis, please contact the
maintainer or chat by clicking the `gitter` button at the top of this README file.
Connect `R` to `JAGS`
---------------------------------
#### Mac OSX (10.11+)
1. Use [Just Another Gibbs Sampler (JAGS)](https://mcmc-jags.sourceforge.io/)
2. Install JAGS 4.3.2 (or 4.2.0 - currently it is slightly slower for 4.3.2, which was updated to be compatible with R 4.3.x); Download [here](https://sourceforge.net/projects/mcmc-jags/files/JAGS/4.x/Mac%20OS%20X/)
3. Install `R`; Download from [here](https://cran.r-project.org/)
4. Fire up `R`, run `R` command `install.packages("rjags")`
5. Run `R` command `library(rjags)` in R console; If the installations are successful, you'll see some notes like this:
wzxhzdk:5
- Run `R` command `library(baker)`. If the package `ks` cannot be loaded due to failure of loading package `rgl`, first install X11 by going [here](https://www.xquartz.org/releases/XQuartz-2.7.11.html), followed by
wzxhzdk:6
#### Unix (Build from source without administrative privilege)
Here we use [JHPCE](https://jhpce.jhu.edu/) as an example. [The complete installation guide](https://sourceforge.net/projects/mcmc-jags/files/Manuals/4.x/) offers
extra information.
1. Download source code for [JAGS 4.2.0](https://sourceforge.net/projects/mcmc-jags/files/JAGS/4.x/Source/JAGS-4.2.0.tar.gz/download);
The workflow would be similar for later versions of `JAGS`.
2. Suppose you've downloaded it in `~/local/jags/4.2.0`. Follow the bash commands below:
``` bash
# change to the directory with the newly downloaded source files:
cd ~/local/jags/4.2.0
# create a new folder named "usr"
mkdir usr
# decompress files:
tar zxvf JAGS-4.2.0.tar.gz
# change to the directory with newly decompressed files:
cd ~/local/jags/4.2.0/JAGS-4.2.0
# specify new JAGS home:
export JAGS_HOME=$HOME/local/jags/4.2.0/usr
export PATH=$JAGS_HOME/bin:$PATH
# link to BLAS and LAPACK:
# Here I have used "/usr/lib64/atlas/" and "/usr/lib64/" on JHPCE that give me
# access to libblas.so.3 and liblapack.so.3. Please modify to paths on your system.
LDFLAGS="-L/usr/lib64/atlas/ -L/usr/lib64/" ./configure --prefix=$JAGS_HOME --libdir=$JAGS_HOME/lib64
# if you have 8 cores:
make -j8
make install
# prepare to install R package, rjags:
export PKG_CONFIG_PATH=$HOME/local/jags/4.2.0/usr/lib64/pkgconfig
module load R
R> install.packages("rjags")
# or if the above fails, try:
R>install.packages("rjags", configure.args="--enable-rpath")
```
3. Also check out the [INSTALLATION](https://CRAN.R-project.org/package=rjags/INSTALL) file for `rjags` package.
Submitting Jobs to Computing Cluster via a shell script
---------------------------------
Again, I use JHPCE as an example.
wzxhzdk:7
#### Windows
- JAGS 4.2.0 (also applicable to later versions)
1. Install `R`; Download from [here](https://cran.r-project.org/)
2. Install [JAGS 4.2.0](https://sourceforge.net/projects/mcmc-jags/files/JAGS/4.x/Windows/); Add the path to JAGS 4.2.0 into the environmental variable (essential for R to find the jags program). See [this](https://superuser.com/questions/949560/how-do-i-set-system-environment-variables-in-windows-10) for setting environmental variables;
- alternatives are `brew install -v jags` for OSX, `sudo apt-get install jags` for Ubuntu/Debian
3. Fire up `R`, run `R` command `install.packages("rjags")`
4. Install [`Rtools`](https://cran.r-project.org/bin/windows/Rtools/) (for building and installing R packages from source); Add the path to `Rtools` (e.g., `C:\Rtools\`) into your environmental variables so that R knows where to find it.
#### Example data sets
We provide two simulated data sets in the package:
`data(data_nplcm_noreg)`
`data(data_nplcm_reg_nest)`
zhenkewu/baker documentation built on Feb. 7, 2024, 4:20 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
library(badger) knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%" )
baker: Bayesian Analysis Kit for Etiology Research
An R Package for Fitting Bayesian Nested Partially Latent Class Models
r badger::badge_cran_release("baker", "green")
r badger::badge_cran_download("baker", "grand-total", "green")
r badger::badge_cran_download("baker", "last-month", "green")
r badger::badge_cran_download("baker", "last-week", "green")
r badger::badge_devel("zhenkewu/baker", "blue")
r badger::badge_lifecycle("maturing", "blue")
Maintainer: Zhenke Wu, zhenkewu@umich.edu
Source Code: Please click here for source code on GitHub.
Issues: Please click here to report reproducible issues.
Vignette: Please click here to read the latest long-version vignette; a short version can be found here.
Package website: Please click here for a website generated by pkgdown, which contains html format of the package manual ("Refence").
References: If you are using baker for population and individual estimation from case-control data, please cite the following papers:
| | Citation |
| ------------- | ------------- |
| partially Latent Class Models (pLCM) | Wu, Z., Deloria-Knoll, M., Hammitt, L. L., Zeger, S. L. and the Pneumonia Etiology Research for Child Health Core Team (2016), Partially latent class models for case–control studies of childhood pneumonia aetiology. J. R. Stat. Soc. C, 65: 97–114. r badger::badge_doi("10.1111/rssc.12101", "yellow")|
| nested pLCM | Wu, Z., Deloria-Knoll, M., Zeger, S.L.; Nested partially latent class models for dependent binary data; estimating disease etiology. Biostatistics 2017; 18 (2): 200-213. r badger::badge_doi("10.1093/biostatistics/kxw037", "yellow")|
| nested pLCM regression | Wu, Z., Chen, I (2021). Probabilistic Cause-of-disease Assignment using Case-control Diagnostic Tests: A Hierarchical Bayesian Approach. Statistics in Medicine 40(4):823-841. r badger::badge_doi("10.1002/sim.8804", "yellow")|
| Application |Maria Deloria Knoll, Wei Fu, Qiyuan Shi, Christine Prosperi, Zhenke Wu, Laura L. Hammitt, Daniel R. Feikin, Henry C. Baggett, Stephen R.C. Howie, J. Anthony G. Scott, David R. Murdoch, Shabir A. Madhi, Donald M. Thea, W. Abdullah Brooks, Karen L. Kotloff, Mengying Li, Daniel E. Park, Wenyi Lin, Orin S. Levine, Katherine L. O’Brien, Scott L. Zeger; Bayesian Estimation of Pneumonia Etiology: Epidemiologic Considerations and Applications to the Pneumonia Etiology Research for Child Health Study, Clinical Infectious Diseases, Volume 64, Issue suppl_3, 15 June 2017, Pages S213–S227 r badger::badge_doi("10.1093/cid/cix144", "yellow")|
| Primary PERCH Analysis | The PERCH Study Group (2019). Aetiology of severe hospitalized pneumonia in HIV-uninfected children from Africa and Asia: the Pneumonia Aetiology Research for Child Health (PERCH) Case-Control Study. The Lancet 394(10200): 757-779. r badger::badge_doi("10.1016/S0140-6736(19)30721-4", "yellow")|
| Software paper | Chen I, Shi Q, Zeger SL, Wu Z (2022+) baker: An R package for Nested Partially-Latent Class Models. r badge_custom("arxiv", "preprint", "red", "https://arxiv.org/abs/2202.11778") r badge_custom("vignette", "workflow", "blue", "https://zhenkewu.com/assets/html/baker_vignette.html")|
There are a number of scientific papers on global health and infectious diseases that have used the model and some the software (in its earlier versions). Some notable examples are listed below:
| | Notable References using baker (model and/or software)|
| ------------- | ------------- |
|1 |Kubale et al. (2023). Etiology of acute lower respiratory illness hospitalizations among infants in four countries. Open Forum Infectious Diseases, ofad580. r badger::badge_doi("10.1093/ofid/ofad580", "green")
|2 |Saha SK et al. (2018). Causes and incidence of community-acquired serious infections among young children in south Asia (ANISA): an observational cohort study. The Lancet 392(10142):145-159. r badger::badge_doi("10.1016/S0140-6736(18)31127-9","green")
Table of content
- 1. Installation - 2. Vignettes - 3. Graphical User Interface (GUI) - 4. Analytic Goal - 5. Comparison to Other Existing Solutions - 6. Details - 7. Platform - 8. ConnectR to JAGS on Unix systems or OSX
- 9. Submit Jobs to Computing Cluster via a shell script
- 10. Connect R to JAGS on Windows
- 11. Example Datasets
Installation
--------------
wzxhzdk:1
Note:
* run `install.packages("pbkrtest")` for `R(>=3.2.3)` if this
package is reported as missing.
* Windows User: use `devtools::install_github("zhenkewu/baker",INSTALL_opts=c("--no-multiarch"))` instead if you see an error message `ERROR: loading failed for 'i386'` (Thanks Chrissy!).
Vignettes
-------------
wzxhzdk:2
Graphical User Interface (GUI)
--------------------------------
wzxhzdk:3
For developers interested in low-level details, here is a pretty awesome [visualization](https://stackoverflow.com/questions/44143110/visualizing-r-function-dependencies)
of the function dependencies within the package:
wzxhzdk:4
You will get a dynamic figure. A snapshot is below:
Analytic Goal
-------------------------------------
- To study disease etiology from case-control data from multiple sources that have measurement errors. If you are interested in estimating the population etiology pie (fraction), and the probability of each cause for individual case, try `baker`.
Comparison to Other Existing Solutions
------------------------------------------------
- Acknowledges various levels of measurement errors and combines multiple sources
of data for optimal disease diagnosis.
- Main function: `nplcm()` that fits the model with or without covariates.
Details
-------------------------------------
1. Implements hierarchical Bayesian models to infer disease etiology for multivariate binary data. The package builds in functionalities for data cleaning, exploratory data analyses, model specification, model estimation, visualization and model diagnostics and comparisons, catalyzing vital effective communications between analysts and practicing clinicians.
2. `baker` has implemented models for dependent measurements given disease status, regression analyses of etiology, multiple imperfect measurements, different priors for true positive rates among cases with differential measurement characteristics, and multiple-pathogen etiology.
3. Scientists in [Pneumonia Etiology Research for Child Health](https://www.jhsph.edu/ivac/) (PERCH) study usually refer to the etiology distribution as "*population etiology pie*" and "*individual etiology pie*" for their compositional nature, hence the name of the package.
Platform
---------
- The `baker` package is compatible with OSX, Linux and Windows systems, each requiring a slightly different setup as described below. If you need to speed up the installation and analysis, please contact the
maintainer or chat by clicking the `gitter` button at the top of this README file.
Connect `R` to `JAGS`
---------------------------------
#### Mac OSX (10.11+)
1. Use [Just Another Gibbs Sampler (JAGS)](https://mcmc-jags.sourceforge.io/)
2. Install JAGS 4.3.2 (or 4.2.0 - currently it is slightly slower for 4.3.2, which was updated to be compatible with R 4.3.x); Download [here](https://sourceforge.net/projects/mcmc-jags/files/JAGS/4.x/Mac%20OS%20X/)
3. Install `R`; Download from [here](https://cran.r-project.org/)
4. Fire up `R`, run `R` command `install.packages("rjags")`
5. Run `R` command `library(rjags)` in R console; If the installations are successful, you'll see some notes like this:
wzxhzdk:5
- Run `R` command `library(baker)`. If the package `ks` cannot be loaded due to failure of loading package `rgl`, first install X11 by going [here](https://www.xquartz.org/releases/XQuartz-2.7.11.html), followed by
wzxhzdk:6
#### Unix (Build from source without administrative privilege)
Here we use [JHPCE](https://jhpce.jhu.edu/) as an example. [The complete installation guide](https://sourceforge.net/projects/mcmc-jags/files/Manuals/4.x/) offers
extra information.
1. Download source code for [JAGS 4.2.0](https://sourceforge.net/projects/mcmc-jags/files/JAGS/4.x/Source/JAGS-4.2.0.tar.gz/download);
The workflow would be similar for later versions of `JAGS`.
2. Suppose you've downloaded it in `~/local/jags/4.2.0`. Follow the bash commands below:
``` bash
# change to the directory with the newly downloaded source files:
cd ~/local/jags/4.2.0
# create a new folder named "usr"
mkdir usr
# decompress files:
tar zxvf JAGS-4.2.0.tar.gz
# change to the directory with newly decompressed files:
cd ~/local/jags/4.2.0/JAGS-4.2.0
# specify new JAGS home:
export JAGS_HOME=$HOME/local/jags/4.2.0/usr
export PATH=$JAGS_HOME/bin:$PATH
# link to BLAS and LAPACK:
# Here I have used "/usr/lib64/atlas/" and "/usr/lib64/" on JHPCE that give me
# access to libblas.so.3 and liblapack.so.3. Please modify to paths on your system.
LDFLAGS="-L/usr/lib64/atlas/ -L/usr/lib64/" ./configure --prefix=$JAGS_HOME --libdir=$JAGS_HOME/lib64
# if you have 8 cores:
make -j8
make install
# prepare to install R package, rjags:
export PKG_CONFIG_PATH=$HOME/local/jags/4.2.0/usr/lib64/pkgconfig
module load R
R> install.packages("rjags")
# or if the above fails, try:
R>install.packages("rjags", configure.args="--enable-rpath")
```
3. Also check out the [INSTALLATION](https://CRAN.R-project.org/package=rjags/INSTALL) file for `rjags` package.
Submitting Jobs to Computing Cluster via a shell script
---------------------------------
Again, I use JHPCE as an example.
wzxhzdk:7
#### Windows
- JAGS 4.2.0 (also applicable to later versions)
1. Install `R`; Download from [here](https://cran.r-project.org/)
2. Install [JAGS 4.2.0](https://sourceforge.net/projects/mcmc-jags/files/JAGS/4.x/Windows/); Add the path to JAGS 4.2.0 into the environmental variable (essential for R to find the jags program). See [this](https://superuser.com/questions/949560/how-do-i-set-system-environment-variables-in-windows-10) for setting environmental variables;
- alternatives are `brew install -v jags` for OSX, `sudo apt-get install jags` for Ubuntu/Debian
3. Fire up `R`, run `R` command `install.packages("rjags")`
4. Install [`Rtools`](https://cran.r-project.org/bin/windows/Rtools/) (for building and installing R packages from source); Add the path to `Rtools` (e.g., `C:\Rtools\`) into your environmental variables so that R knows where to find it.
#### Example data sets
We provide two simulated data sets in the package:
`data(data_nplcm_noreg)`
`data(data_nplcm_reg_nest)`
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.