From 8ec217769d43729bce3c93d9b91cbcf25e762b39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Pelletier?= Date: Wed, 5 Mar 2014 21:57:44 -0500 Subject: [PATCH] Ajout des return() et update du namespace avec roxygen --- NAMESPACE | 47 ++++++++++++++++++------------------- R/M.Crowder.Mod.R | 2 +- R/M.Crowder.R | 2 +- R/M.gauss.R | 2 +- R/V.Crowder.Mod.R | 2 +- R/V.Crowder.R | 2 +- R/V.gauss.R | 2 +- R/Wald.Test.R | 2 +- R/a.Crowder.Mod.R | 2 +- R/a.Crowder.R | 2 +- R/a.gauss.R | 2 +- R/b.Crowder.Mod.R | 2 +- R/b.Crowder.R | 2 +- R/b.gauss.R | 2 +- R/confidence.interval.QEE.R | 2 +- R/covariance.QEE.R | 1 + R/eqn.Crowder.Mod.R | 2 +- R/eqn.Crowder.R | 2 +- R/eqn.gauss.R | 2 +- R/gammaf.Crowder.Mod.R | 2 +- R/gammaf.Crowder.R | 2 +- R/obj.Crowder.Mod.R | 2 +- R/obj.Crowder.R | 2 +- R/obj.gauss.R | 2 +- 24 files changed, 46 insertions(+), 46 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 3c1dc72..cd3d2a4 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,24 +1,23 @@ -export(a.Crowder.Mod, -a.Crowder, -a.gauss, -b.Crowder.Mod, -b.Crowder, -b.gauss, -confidence.interval.QEE, -covariance.QEE, -eqn.Crowder.Mod, -eqn.Crowder, -eqn.gauss, -gammaf.Crowder.Mod, -gammaf.Crowder, -M.Crowder.Mod, -M.Crowder, -M.gauss, -obj.Crowder.Mod, -obj.Crowder, -obj.gauss, -V.Crowder.Mod, -V.Crowder, -V.gauss, -Wald.Test -) \ No newline at end of file +export(M.Crowder) +export(M.Crowder.Mod) +export(M.gauss) +export(V.Crowder) +export(V.Crowder.Mod) +export(V.gauss) +export(Wald.Test) +export(a.Crowder) +export(a.Crowder.Mod) +export(a.gauss) +export(b.Crowder) +export(b.Crowder.Mod) +export(b.gauss) +export(confidence.interval.QEE) +export(covariance.QEE) +export(eqn.Crowder) +export(eqn.Crowder.Mod) +export(eqn.gauss) +export(gammaf.Crowder) +export(gammaf.Crowder.Mod) +export(obj.Crowder) +export(obj.Crowder.Mod) +export(obj.gauss) diff --git a/R/M.Crowder.Mod.R b/R/M.Crowder.Mod.R index 964edf0..b70f161 100644 --- a/R/M.Crowder.Mod.R +++ b/R/M.Crowder.Mod.R @@ -16,7 +16,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return M Matrix -#' +#' @export M.Crowder.Mod #' @author Francois Pelletier M.Crowder.Mod <- function(param,Y,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/M.Crowder.R b/R/M.Crowder.R index 1e23c9f..d752088 100644 --- a/R/M.Crowder.R +++ b/R/M.Crowder.R @@ -17,7 +17,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return M Matrix -#' +#' @export M.Crowder #' @author Francois Pelletier M.Crowder <- function(param,Y,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/M.gauss.R b/R/M.gauss.R index b80289e..55e7230 100644 --- a/R/M.gauss.R +++ b/R/M.gauss.R @@ -13,7 +13,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return M Matrix -#' +#' @export M.gauss #' @author Francois Pelletier M.gauss <- function(param,Y,meanf,variancef,dmean,dsd) { diff --git a/R/V.Crowder.Mod.R b/R/V.Crowder.Mod.R index 438652f..815e02e 100644 --- a/R/V.Crowder.Mod.R +++ b/R/V.Crowder.Mod.R @@ -13,7 +13,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return V Matrix -#' +#' @export V.Crowder.Mod #' @author Francois Pelletier V.Crowder.Mod <- function(param,Y,variancef,dmean,dsd) { diff --git a/R/V.Crowder.R b/R/V.Crowder.R index 7b729e2..57859fd 100644 --- a/R/V.Crowder.R +++ b/R/V.Crowder.R @@ -15,7 +15,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return V Matrix -#' +#' @export V.Crowder #' @author Francois Pelletier V.Crowder <- function(param,Y,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/V.gauss.R b/R/V.gauss.R index 9a96309..716c5bc 100644 --- a/R/V.gauss.R +++ b/R/V.gauss.R @@ -16,7 +16,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return V Matrix -#' +#' @export V.gauss #' @author Francois Pelletier V.gauss <- function(param,Y,meanf,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/Wald.Test.R b/R/Wald.Test.R index 8cebac5..7960456 100644 --- a/R/Wald.Test.R +++ b/R/Wald.Test.R @@ -15,7 +15,7 @@ #' @param eqn.gradient Gradient matrix of the estimating equations #' @param alpha level of confidence #' @return A list containing the statistic, p-value and reject of the null hypothesis -#' +#' @export Wald.Test #' @author François Pelletier Wald.Test <- function(param,n,R,r,eqn.covariance,eqn.gradient,alpha=0.05) { diff --git a/R/a.Crowder.Mod.R b/R/a.Crowder.Mod.R index 7307539..92fc567 100644 --- a/R/a.Crowder.Mod.R +++ b/R/a.Crowder.Mod.R @@ -13,7 +13,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return First weighting vector -#' +#' @export a.Crowder.Mod #' @author Francois Pelletier a.Crowder.Mod <- function(param,Y,variancef,dmean,dsd) { diff --git a/R/a.Crowder.R b/R/a.Crowder.R index dea9e36..c5587de 100644 --- a/R/a.Crowder.R +++ b/R/a.Crowder.R @@ -14,7 +14,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return First weighting vector -#' +#' @export a.Crowder #' @author Francois Pelletier a.Crowder <- function(param,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/a.gauss.R b/R/a.gauss.R index 1a4c223..bfbf82e 100644 --- a/R/a.gauss.R +++ b/R/a.gauss.R @@ -10,7 +10,7 @@ #' @param variancef Variance function of the distribution #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @return First weighting vector -#' +#' @export a.gauss #' @author Francois Pelletier a.gauss <- function(param,variancef,dmean) { diff --git a/R/b.Crowder.Mod.R b/R/b.Crowder.Mod.R index e9c7a55..360a9e5 100644 --- a/R/b.Crowder.Mod.R +++ b/R/b.Crowder.Mod.R @@ -13,7 +13,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return First weighting vector -#' +#' @export b.Crowder.Mod #' @author Francois Pelletier b.Crowder.Mod <- function(param,Y,variancef,dmean,dsd) { diff --git a/R/b.Crowder.R b/R/b.Crowder.R index 38921d3..d6eaa55 100644 --- a/R/b.Crowder.R +++ b/R/b.Crowder.R @@ -14,7 +14,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return First weighting vector -#' +#' @export b.Crowder #' @author Francois Pelletier b.Crowder <- function(param,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/b.gauss.R b/R/b.gauss.R index e2824d6..dc51081 100644 --- a/R/b.gauss.R +++ b/R/b.gauss.R @@ -10,7 +10,7 @@ #' @param variancef Variance function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return Second weighting vector -#' +#' @export b.gauss #' @author Francois Pelletier b.gauss <- function(param,variancef,dsd) { diff --git a/R/confidence.interval.QEE.R b/R/confidence.interval.QEE.R index 80a6d7c..12b370f 100644 --- a/R/confidence.interval.QEE.R +++ b/R/confidence.interval.QEE.R @@ -12,7 +12,7 @@ #' @param covariance Covariance matrix #' @param alpha confidence level #' @return 3 line matrix with lower bound, estimate and upper bound -#' +#' @export confidence.interval.QEE #' @author François Pelletier confidence.interval.QEE <- function(param,covariance,n,alpha=0.05) { diff --git a/R/covariance.QEE.R b/R/covariance.QEE.R index 16eef5c..568eaaa 100644 --- a/R/covariance.QEE.R +++ b/R/covariance.QEE.R @@ -12,6 +12,7 @@ #' @param V Covariance matrix of equations #' @param n Sample size #' @return Weighted covariance matrix +#' @export covariance.QEE #' @author François Pelletier covariance.QEE <- function(M,V,n) ## Omega { diff --git a/R/eqn.Crowder.Mod.R b/R/eqn.Crowder.Mod.R index dd551db..4a8f0ce 100644 --- a/R/eqn.Crowder.Mod.R +++ b/R/eqn.Crowder.Mod.R @@ -14,7 +14,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return The vector value of the estimating equation -#' +#' @export eqn.Crowder.Mod #' @author Francois Pelletier eqn.Crowder.Mod <- function(param,Y,meanf,variancef,dmean,dsd) { diff --git a/R/eqn.Crowder.R b/R/eqn.Crowder.R index aa189ae..d7f70aa 100644 --- a/R/eqn.Crowder.R +++ b/R/eqn.Crowder.R @@ -16,7 +16,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return The vector value of the estimating equation -#' +#' @export eqn.Crowder #' @author Francois Pelletier eqn.Crowder <- function(param,Y,meanf,variancef,skewnessf,kurtosisf,dmean,dsd) { diff --git a/R/eqn.gauss.R b/R/eqn.gauss.R index fd4a29b..c400620 100644 --- a/R/eqn.gauss.R +++ b/R/eqn.gauss.R @@ -14,7 +14,7 @@ #' @param dmean Derivative in respect to the parameter vector of the mean function of the distribution #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @return The vector value of the estimating equation -#' +#' @export eqn.gauss #' @author Francois Pelletier eqn.gauss <- function(param,Y,meanf,variancef,dmean,dsd) { diff --git a/R/gammaf.Crowder.Mod.R b/R/gammaf.Crowder.Mod.R index 8542005..c4016cb 100644 --- a/R/gammaf.Crowder.Mod.R +++ b/R/gammaf.Crowder.Mod.R @@ -9,7 +9,7 @@ #' Gamma function used in Modified Crowder Estimating Equations #' @param Y Individual data sample #' @return Gamma function value -#' +#' @export gammaf.Crowder.Mod #' @author Francois Pelletier gammaf.Crowder.Mod <- function(Y) { diff --git a/R/gammaf.Crowder.R b/R/gammaf.Crowder.R index 5ab90ec..9a38ea7 100644 --- a/R/gammaf.Crowder.R +++ b/R/gammaf.Crowder.R @@ -11,7 +11,7 @@ #' @param skewnessf Skewness function of the distribution #' @param kurtosisf Kurtosis function of the distribution #' @return Gamma function value -#' +#' @export gammaf.Crowder #' @author Francois Pelletier gammaf.Crowder <- function(param,skewnessf,kurtosisf) { diff --git a/R/obj.Crowder.Mod.R b/R/obj.Crowder.Mod.R index 1c736a1..ed9c70a 100644 --- a/R/obj.Crowder.Mod.R +++ b/R/obj.Crowder.Mod.R @@ -14,7 +14,7 @@ #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @param Q Weight matrix #' @return The value of the quadratic form -#' +#' @export obj.Crowder.Mod #' @author Francois Pelletier obj.Crowder.Mod <- function(param,Y,meanf,variancef,dmean,dsd,Q=diag(4)) { diff --git a/R/obj.Crowder.R b/R/obj.Crowder.R index 659e789..38636ab 100644 --- a/R/obj.Crowder.R +++ b/R/obj.Crowder.R @@ -16,7 +16,7 @@ #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @param Q Weight matrix #' @return The value of the quadratic form -#' +#' @export obj.Crowder #' @author Francois Pelletier obj.Crowder <- function(param,Y,meanf,variancef,skewnessf,kurtosisf,dmean,dsd,Q=diag(4)) { diff --git a/R/obj.gauss.R b/R/obj.gauss.R index a8560c0..47e1d60 100644 --- a/R/obj.gauss.R +++ b/R/obj.gauss.R @@ -14,7 +14,7 @@ #' @param dsd Derivative in respect to the parameter vector of the standard deviation function of the distribution #' @param Q Weight matrix #' @return The value of the quadratic form -#' +#' @export obj.gauss #' @author Francois Pelletier obj.gauss <- function(param,Y,meanf,variancef,dmean,dsd,Q=diag(4)) {