Skip to content

Commit

Permalink
Removed PLUE example (will add a better one on arXiv)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrechalom committed Jul 7, 2015
1 parent 839c596 commit dacc07a
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions man/PLUE.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -18,41 +18,33 @@ PLUE(model=NULL, factors, N, LL, start, res.names=NULL, method = c("internal", "
\method{print}{PLUE} (x, ...)
\method{plot}{PLUE} (x, ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{model}{
The function to be run, representing the model or simulation.
%% ~~Describe \code{model} here~~
}
\item{factors}{
The names of the input variables (used for naming the 'data' data.frame and in plotting)
Either a vector of strings or a single number representing the number of factors
%% ~~Describe \code{factors} here~~
}
\item{N}{
The number of samples to be generated by the Metropolis algorithm.
%% ~~Describe \code{N} here~~
}
\item{LL}{
The POSITIVE Likelihood function to be used by the Metropolis algorithm. It must accept
an array with length equal to the number of factors.
%% ~~Describe \code{LL} here~~
}
\item{start}{
The initial point to be evaluated. Must have the same length as the number of factors.
%% ~~Describe \code{start} here~~
}
\item{res.names}{
Optional: what are the names of the model results? (Used mainly for plotting)
}
\item{method}{
May be either "internal", which runs a naive and inneficient algorithm provided for test
and didatic purposes, or "mcmc", which will run the \code{metrop} function from the \code{mcmc} package.
%% ~~Describe \code{method} here~~
}
\item{opts}{
Further options to be passed to the Metropolis function. See the help on \code{mcmc::metrop}.
%% ~~Describe \code{opts} here~~
}
\item{nboot}{
Number of bootstrap replicates for calculating the PRCC.
Expand All @@ -77,14 +69,3 @@ PLUE(model=NULL, factors, N, LL, start, res.names=NULL, method = c("internal", "
Further options
}
}
\examples{
my.LL <- function(x) {
dbinom(10, 100, x[1], log=TRUE)
+ dbinom(30, 100, x[2], log=TRUE)
+ dbinom(90, 100, x[3], log=TRUE)
}
plue <- PLUE(model=function(x) x[,1]+x[,2]*x[,3], factors=3,
N=10000, LL=my.LL, start=rep(0.5, 3))
print(plue)
plot(plue)
}

0 comments on commit dacc07a

Please sign in to comment.