loadpexm: loadpexm

Description Usage Arguments Details Value References See Also Examples

View source: R/loadpexm.R

Description

Function to load the Just Another Gibbs Sampling (JAGS) module pexm into the R environment.

Usage

1
loadpexm(f.path = NULL)

Arguments

f.path

This is an optional argument. If having difficulties to find the main file "pexm.so" (unix) or "pexm.dll" (windows), the user may choose to manually include here the corresponding quoted path to the target directory.

Details

The main purpose of the present function is to load the target JAGS module pexm into the R environment. The pexm module allows the application of the Piecewise Exponential (PE) distribution in any Bayesian model implemented through JAGS. In order to apply this loading routine, it is necessary to have JAGS installed in the computer. The supporting package rjags is also required and it should have been automatically installed together with pexm. Important remark for Windows users: the JAGS version 4.3.0 is the one considered in the present implementation of pexm. If working with another version, one must download the source code of pexm and then modify the file "Makevars.win" (directory src). In this case, simply adapt the path in JAGS_ROOT with the correct version number. In order to build the present package, the source code of runjags (Denwood; 2016) was used as an example. Details about pexm and the piecewise exponential model can be found in Mayrink et al. (2021).

Value

Indication of whether the JAGS module pexm was correctly loaded in the R environment.

References

DOI:10.18637/jss.v071.i09 (Denwood; 2016)

DOI:10.18637/jss.v100.i08 (Mayrink et al.; 2021)

See Also

pexm

Examples

1
2
# Load the new module with the command below:
 loadpexm() 

pexm documentation built on Dec. 15, 2021, 1:08 a.m.