Update to make it compatible with CRAN 0.7-1

Mainly documentation improvements

Author: handcock

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: rpm
 Type: Package
 Title: Modeling of Revealed Preferences Matchings
-Version: 0.7
-Date: 2023-04-18
+Version: 0.7-1
+Date: 2023-04-21
 Authors@R: c(
         person("Mark S.", "Handcock", role=c("aut","cre"), email="handcock@stat.ucla.edu", comment=c(ORCID="0000-0002-9985-2785")),
         person("Ryan M. ", "Admiraal", role=c("ctb"), email="ryan.admiraal@vuw.ac.nz"),
@@ -14,7 +14,7 @@ Description: Statistical estimation of revealed preference models from data coll
 License: GPL-3 + file LICENSE
 License_is_FOSS: yes
 License_restricts_use: no
-URL: https://handcock.github.io
+URL: https://github.com/handcock/rpm
 LinkingTo: Rcpp, RcppArmadillo
 Depends:
     R (>= 4.0.0),

R/Gale_Shapley.R

@@ -25,12 +25,18 @@
 #' Each row is a woman, each column is a man. The order of the rows is the same as the 
 #' rows in \code{U}. The order of the columns is the same as the columns in \code{V}.}
 #' @seealso rpm
-#' @references Goyal, Handcock, Jackson. Rendall and Yeung (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
-#' Menzel, K. (2015).
+#'
+#' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
+#' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
+#' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
-#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941.
+#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}
 #' @keywords models
 #' @export Gale_Shapley
 #'@importFrom Rcpp evalCpp

R/data.R

@@ -32,11 +32,11 @@
 #' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
 #' Weights are specified by three optional variables in \code{Xdata}.
 #' \itemize{
-#' \item{X_w}{ The weight variable for women. The sum of the weights of the sampled women is the
+#' \item{X_w}{: The weight variable for women. The sum of the weights of the sampled women is the
 #' number of women in the population.}
-#' \item{Z_w}{ The weight variable for men. The sum of the weights of the sampled men is the
+#' \item{Z_w}{: The weight variable for men. The sum of the weights of the sampled men is the
 #' number of men in the population.}
-#' \item{pair_w}{ The weight variable for pairs.}
+#' \item{pair_w}{: The weight variable for pairs.}
 #' }
 #' @examples
 #' library(rpm)

R/gof.rpm.R

@@ -10,7 +10,7 @@
 #' matchings and a set of (possibly dyadic) covariates to 
 #' estimate the parameters for
 #' linear equations of utilities.
-#' It does this using a large-population likelihood based on ideas from Menzel (2015).
+#' It does this using an large-population likelihood based on ideas from Dagsvik (2000), Menzel (2015) and Goyal et al (2023).
 #' 
 #' The model represents the dyadic utility functions as deterministic linear utility functions of
 #' dyadic variables. These utility functions are functions of observed characteristics of the women
@@ -70,12 +70,18 @@
 #'           sampled="sampled")
 #' a <- gof(fit)
 #' }
-#' @references Goyal, Handcock, Jackson. Rendall and Yeung (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
-#' Menzel, K. (2015).
+#'
+#' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
+#' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
+#' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
-#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941.
+#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}
 #' @export gof
 gof <- function(object, ...){
   UseMethod("gof")

R/microsimulate.rpm.R

@@ -58,11 +58,15 @@
 #' pmfM_N <- round(fit$pmfM * num_men)
 #' a <- microsimulate(fit, pmfW_N=pmfW_N, pmfM_N=pmfM_N)
 #'}
-#' @references Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
+#'
 #' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
 #' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
 #' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
 #' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}

R/rpm-package.R

@@ -62,11 +62,15 @@
 #' # For information on the current terms that can be used in formulas:
 #' help("rpm-terms")
 #' 
-#' @references Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
+#'
 #' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
 #' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
 #' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
 #' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}

R/rpm-terms.R

@@ -7,7 +7,7 @@
 #' matchings and a set of (possibly dyadic) covariates to 
 #' estimate the parameters for
 #' linear equations of utilities.
-#' It does this using a large-population likelihood based on ideas from Menzel (2015).
+#' It does this using an large-population likelihood based on ideas from Dagsvik (2000), Menzel (2015) and Goyal et al (2023).
 #' 
 #' The model represents the dyadic utility functions as deterministic linear utility functions of
 #' dyadic variables. These utility functions are functions of observed characteristics of the women
@@ -146,12 +146,18 @@
 #' @return No return value, called for side effects.
 #' @seealso \code{\link[=rpm-package]{rpm}} package,
 #' \code{\link{rpm}}
-#' @references Goyal, Handcock, Jackson. Rendall and Yeung (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
-#' Menzel, K. (2015).
+#'
+#' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
+#' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
+#' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
-#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941.
+#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}
 #' 
 #' @keywords models
 #' @examples

R/rpm.R

@@ -49,11 +49,11 @@
 #' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
 #' Weights are specified by three optional variables in \code{Xdata}.
 #' \itemize{
-#' \item{X_w}{This is character string of the name of the weight variable for women. The sum of the weights should be the
+#' \item{X_w}{: This is character string of the name of the weight variable for women. The sum of the weights should be the
 #' number of women in the population.}
-#' \item{Z_w}{This is character string of the name of the weight variable for men. The sum of the weights should be the
+#' \item{Z_w}{: This is character string of the name of the weight variable for men. The sum of the weights should be the
 #' number of men in the population.}
-#' \item{pair_w}{This is character string of the name of the weight variable for pairs.}
+#' \item{pair_w}{: This is character string of the name of the weight variable for pairs.}
 #' }
 #' @return \code{\link{rpm}} returns an object of class \code{\link{rpm.object}}
 #' that is a list consisting of the following elements: 
@@ -79,11 +79,15 @@
 #' \item{eq}{Values from the equality constraints. Larger values indicate non-convergence.}
 #' \item{sample}{A matrix with the number of rows the MCMC sample size and the number of rows the number of parameters.}
 #' @seealso control.rpm, summary.rpm, print.rpm
-#' @references Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
+#'
 #' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
 #' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
 #' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
 #' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}

R/rpm.model.functions.R

@@ -12,12 +12,18 @@
 #' \code{\link{control.rpm}}, which should be consulted for specifics. 
 #' @return A list of model terms as bivariate functions.
 #' @seealso rpm
-#' @references Goyal, Handcock, Jackson. Rendall and Yeung (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
-#' Menzel, K. (2015).
+#'
+#' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
+#' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
+#' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
-#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941.
+#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}
 #' @keywords models
 #' @examples
 #' # nothing yet

R/rpm.model.matrix.R

@@ -17,12 +17,18 @@
 #' \item{Xnames}{the names of the covariates for women.} 
 #' \item{Znames}{the names of the covariates for men.}
 #' @seealso rpm
-#' @references Goyal, Handcock, Jackson. Rendall and Yeung (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
-#' Menzel, K. (2015).
+#'
+#' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
+#' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
+#' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
-#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941.
+#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}
 #' @keywords models
 #' @examples
 #' # nothing yet

R/rpm.utilities.R

@@ -107,6 +107,7 @@ rpm.hessian_nog <- function(theta,Sd,Xd,Zd,NumBeta,NumGamma,NumGammaW,NumGammaM,
 #'
 #' @param ... arguments to [`print`].
 #' @param messageArgs a list of arguments to be passed directly to [`message`].
+#' @return No return value, called for side effects.
 #'
 #' @examples
 #' cat(1:5)

R/rpm_MLPLE.R

@@ -7,7 +7,7 @@
 #' matchings and a set of (possibly dyadic) covariates to 
 #' estimate the parameters for
 #' linear equations of utilities.
-#' It does this using a large-population approximation to the likelihood based on ideas from Menzel (2015).
+#' It does this using an large-population likelihood based on ideas from Dagsvik (2000), Menzel (2015) and Goyal et al (2023).
 #' 
 #' It is usually called via the \code{\link{rpm}} function.
 #' @param formula formula; an \code{\link{formula}} object, of the form \code{
@@ -49,11 +49,11 @@
 #' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
 #' Weights are specified by three optional variables in \code{Xdata}.
 #' \itemize{
-#' \item{X_w}{This is character string of the name of the weight variable for women. The sum of the weights should be the
+#' \item{X_w}{: This is character string of the name of the weight variable for women. The sum of the weights should be the
 #' number of women in the population.}
-#' \item{Z_w}{This is character string of the name of the weight variable for men. The sum of the weights should be the
+#' \item{Z_w}{: This is character string of the name of the weight variable for men. The sum of the weights should be the
 #' number of men in the population.}
-#' \item{pair_w}{This is character string of the name of the weight variable for pairs.}
+#' \item{pair_w}{: This is character string of the name of the weight variable for pairs.}
 #' }
 #' @return \code{\link{rpm}} returns an object of class \code{\link{rpm.object}}
 #' that is a list consisting of the following elements: 
@@ -76,12 +76,18 @@
 #' \item{covar}{Approximate covariance matrix of the estimates.}
 #' \item{eq}{Values from the equality constraints. Larger values indicate non-convergence.}
 #' @seealso control.rpm, summary.rpm, print.rpm
-#' @references Goyal, Handcock, Jackson. Rendall and Yeung (2023).
+#' @references
+#'
+#' Goyal, Shuchi; Handcock, Mark S.; Jackson, Heide M.; Rendall, Michael S. and Yeung, Fiona C. (2023).
 #' \emph{A Practical Revealed Preference Model for Separating Preferences and Availability Effects in Marriage Formation}
 #' \emph{Journal of the Royal Statistical Society}, A. \doi{10.1093/jrsssa/qnad031} 
-#' Menzel, K. (2015).
+#'
+#' Dagsvik, John K. (2000) \emph{Aggregation in Matching Markets} \emph{International Economic Review}, Vol. 41, 27-57.
+#' JSTOR: https://www.jstor.org/stable/2648822, \doi{10.1111/1468-2354.00054}
+#'
+#' Menzel, Konrad (2015).
 #' \emph{Large Matching Markets as Two-Sided Demand Systems}
-#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941.
+#' Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299}
 #' @keywords models
 #' @examples
 #' library(rpm)

R/rpm_make_counts.R

@@ -2,14 +2,18 @@ rpm_make_counts <- function(Xdata, Zdata, sampling_design, sampled, Xid, Zid, pa
 
     num_Xu <- nrow(Xu)
     num_Zu <- nrow(Zu)
-    cnW <- paste(colnames(Xu)[2],Xu[,2], sep=".")
-    for(i in 2:ncol(Xu)){
+    if(ncol(Xu)>1){
+     cnW <- paste(colnames(Xu)[2],Xu[,2], sep=".")
+     for(i in 2:ncol(Xu)){
       cnW <- paste(cnW,paste(colnames(Xu)[i],Xu[,i], sep="."),sep='.')
-    }
-    cnM <- paste(colnames(Zu)[2],Zu[,2], sep=".")
-    for(i in 2:ncol(Zu)){
+     }
+    }else{ cnW <- "Int" }
+    if(ncol(Zu)>1){
+     cnM <- paste(colnames(Zu)[2],Zu[,2], sep=".")
+     for(i in 2:ncol(Zu)){
       cnM <- paste(cnM,paste(colnames(Zu)[i],Zu[,i], sep="."),sep='.')
-    }
+     }
+    }else{ cnM <- "Int" }
 
     if(sampling_design == "stock-stock"){
     # IDs of the women matched to the sampled men (and vice versa)
@@ -73,19 +77,20 @@ rpm_make_counts <- function(Xdata, Zdata, sampling_design, sampled, Xid, Zid, pa
     }
 
     if (sampling_design == "stock-stock") {
+     x_wts <- Xdata[,X_w] * Xdata[,sampled]
+     z_wts <- Zdata[,Z_w] * Zdata[,sampled]
      subset=Xdata[,sampled] &  is.na(Xdata[,pair_id])
      pmfW_S = as.numeric(stats::xtabs(X_w ~ factor(Xtype,1:num_Xu), data=Xdata, subset=subset))
      subset=Xdata[,sampled] & !is.na(Xdata[,pair_id])
-     pmfW_P = as.numeric(stats::xtabs(X_w ~ factor(Xtype,1:num_Xu), data=Xdata, subset=subset))
+     x_wts[subset] <- 0.5*x_wts[subset]
+     pmfW_P = 0.5*as.numeric(stats::xtabs(X_w ~ factor(Xtype,1:num_Xu), data=Xdata, subset=subset))
      pmfW = pmfW_S + pmfW_P
      subset=Zdata[,sampled] &  is.na(Zdata[,pair_id])
      pmfM_S = as.numeric(stats::xtabs(Z_w ~ factor(Ztype,1:num_Zu), data=Zdata, subset=subset))
      subset=Zdata[,sampled] & !is.na(Zdata[,pair_id])
-     pmfM_P = as.numeric(stats::xtabs(Z_w ~ factor(Ztype,1:num_Zu), data=Zdata, subset=subset))
+     z_wts[subset] <- 0.5*z_wts[subset]
+     pmfM_P = 0.5*as.numeric(stats::xtabs(Z_w ~ factor(Ztype,1:num_Zu), data=Zdata, subset=subset))
      pmfM = pmfM_S + pmfM_P
-#   
-     x_wts <- Xdata[,X_w] * Xdata[,sampled]
-     z_wts <- Zdata[,Z_w] * Zdata[,sampled]
     }
     if (sampling_design == "stock-flow") {
      pmfW = as.numeric(stats::xtabs(X_w ~ factor(Xtype,1:num_Xu), data=Xdata, subset=sampled))
@@ -108,8 +113,8 @@ rpm_make_counts <- function(Xdata, Zdata, sampling_design, sampled, Xid, Zid, pa
     }
     pmfW = pmfW/sum(pmfW)
     pmfM = pmfM/sum(pmfM)
-    names(pmfW) <- paste(colnames(Xu)[2],Xu[,2], sep=".") 
-    names(pmfM) <- paste(colnames(Zu)[2],Zu[,2], sep=".")
+    names(pmfW) <- cnW
+    names(pmfM) <- cnM
 
     if(verbose){
      message(sprintf("Proportion population paired size: %f",sum(Zdata[paired_and_sampled_M,Z_w])/n))
@@ -260,6 +265,6 @@ rpm_make_counts <- function(Xdata, Zdata, sampling_design, sampled, Xid, Zid, pa
 
     list(pmf=pmf, counts=counts, pmfW=pmfW, pmfM=pmfM, pmfN=pmfN, N=N, gw=gw, gm=gm,
          num_women=num_women, num_men=num_men, num_sampled=num_sampled,
-         x_wts =x_wts, z_wts=z_wts
+         x_wts=x_wts, z_wts=z_wts
         )
 }