updated documentation.

DESCRIPTION

@@ -2,7 +2,7 @@ Package: bayesmeta
 Type: Package
 Title: Bayesian Random-Effects Meta-Analysis
 Version: 2.5
-Date: 2019-08-07
+Date: 2019-11-28
 Authors@R: c(person(given="Christian", family="Roever", role=c("aut","cre"), 
                     email="christian.roever@med.uni-goettingen.de",
                     comment=c(ORCID="0000-0002-6911-698X")),

man/bayesmeta-package.Rd

@@ -17,7 +17,7 @@
     Package: \tab bayesmeta\cr
     Type:    \tab Package\cr
     Version: \tab 2.5\cr
-    Date:    \tab 2019-08-07\cr
+    Date:    \tab 2019-11-28\cr
     License: \tab GPL (>=2)
   }
   The main functionality is provided by the \code{\link{bayesmeta}()}

man/forestplot.escalc.Rd

 \name{forestplot.escalc}
 \alias{forestplot.escalc}
 \title{
-  Generate a forest plot for an \code{\link{escalc}} object
+  Generate a forest plot for an \code{\link[metafor]{escalc}} object
   (based on the \code{forestplot} package's plotting functions).
 }
 \description{
@@ -15,7 +15,7 @@
 }
 \arguments{
   \item{x}{
-    a \code{\link{bayesmeta}} object.
+    an \code{\link[metafor]{escalc}} object.
   }
   \item{labeltext}{an (alternative) \dQuote{\code{labeltext}} argument
     which is then handed on to the \code{\link[forestplot]{forestplot}()}
@@ -41,7 +41,9 @@
 }
 \details{
   Generates a forest plot illustrating the data returned by the
-  \dQuote{\code{\link[metafor]{escalc}()}} function.
+  \dQuote{\code{\link[metafor]{escalc}()}} function (showing the
+  estimates potentially to be meta-analyzed, but without a combined
+  summary estimate).
 }
 \note{This function is based on the \pkg{forestplot} package's
       \dQuote{\code{\link[forestplot]{forestplot}()}} function.
@@ -72,9 +74,6 @@
 # load data:
 data("CrinsEtAl2014")
 
-\dontrun{
-data("CrinsEtAl2014")
-
 # compute effect sizes (log odds ratios) from count data
 # (using "metafor" package's "escalc()" function):
 crins.es <- escalc(measure="OR",
@@ -85,7 +84,7 @@ print(crins.es)
 
 ########################
 # generate forest plots;
-# default options:
+# with default settings:
 forestplot(crins.es)
 
 # exponentiate values (shown in table and plot), show vertical line at OR=1:
@@ -119,5 +118,4 @@ forestplot(crins.es, clip=c(-4,1), xticks=(-3):0,
            xlab="log-OR", title="pediatric transplantation example",
            txt_gp = fpTxtGp(ticks = gpar(cex=1), xlab = gpar(cex=1)))
 }
-}
 \keyword{ hplot }