From d39a47054182977ba0bd558000f0eeacbe35e3d0 Mon Sep 17 00:00:00 2001 From: handcock Date: Sat, 20 Apr 2024 16:56:24 -0700 Subject: [PATCH] Convert \itemize to \describe tags to be consistent with CRAN --- DESCRIPTION | 2 +- R/data.R | 4 ++-- R/rpm.R | 2 +- R/rpm_MLPLE.R | 2 +- R/summary_rpm.R | 2 +- man/fauxmatching.Rd | 4 ++-- man/rpm-package.Rd | 1 + man/rpm.Rd | 2 +- man/rpm_MLPLE.Rd | 2 +- man/summary_rpm.Rd | 2 +- 10 files changed, 12 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 6045bb1..fb29d65 100755 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -36,4 +36,4 @@ Imports: doFuture, foreach Encoding: UTF-8 -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 diff --git a/R/data.R b/R/data.R index 4049db3..f3ea31e 100644 --- a/R/data.R +++ b/R/data.R @@ -21,7 +21,7 @@ #' the variable with the ID of the women's partner is called \code{pair_id}. If the women is single the men's ID is NA. #' \code{Zdata} is for men. Each row is a man, each column is a variable on that men #' The men's ID variable is called \code{pid}. -#' \itemize{ +#' \describe{ #' \item{pair_id}{ The ID of the person's partner. This is in both \code{Xdata} and \code{Zdata}.} #' \item{sampled}{ The indicator that the person was sampled directly (as distinct from being included as the match of a directly sampled #' person. All single people are directly sampled. This is in both \code{Xdata} and \code{Zdata}.} @@ -31,7 +31,7 @@ #' If that variable is NA then the women is #' 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{ +#' \describe{ #' \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 diff --git a/R/rpm.R b/R/rpm.R index e2d342d..9d8017e 100644 --- a/R/rpm.R +++ b/R/rpm.R @@ -52,7 +52,7 @@ #' If that variable is NA then the women is #' 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{ +#' \describe{ #' \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 diff --git a/R/rpm_MLPLE.R b/R/rpm_MLPLE.R index b1544f1..13223be 100644 --- a/R/rpm_MLPLE.R +++ b/R/rpm_MLPLE.R @@ -52,7 +52,7 @@ #' If that variable is NA then the women is #' 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{ +#' \describe{ #' \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 diff --git a/R/summary_rpm.R b/R/summary_rpm.R index e0782cd..e193d0a 100755 --- a/R/summary_rpm.R +++ b/R/summary_rpm.R @@ -48,7 +48,7 @@ #' If that variable is NA then the women is #' 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{ +#' \describe{ #' \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 diff --git a/man/fauxmatching.Rd b/man/fauxmatching.Rd index 32ecee4..4e49607 100644 --- a/man/fauxmatching.Rd +++ b/man/fauxmatching.Rd @@ -12,7 +12,7 @@ or her partnerships. The women's ID variable s called \code{pid} and the variable with the ID of the women's partner is called \code{pair_id}. If the women is single the men's ID is NA. \code{Zdata} is for men. Each row is a man, each column is a variable on that men The men's ID variable is called \code{pid}. -\itemize{ +\describe{ \item{pair_id}{ The ID of the person's partner. This is in both \code{Xdata} and \code{Zdata}.} \item{sampled}{ The indicator that the person was sampled directly (as distinct from being included as the match of a directly sampled person. All single people are directly sampled. This is in both \code{Xdata} and \code{Zdata}.} @@ -44,7 +44,7 @@ The pairings are determined by the \code{pair_id} variable in \code{Xdata}. If that variable is NA then the women is 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{ +\describe{ \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 diff --git a/man/rpm-package.Rd b/man/rpm-package.Rd index 4ac3b8a..e566238 100644 --- a/man/rpm-package.Rd +++ b/man/rpm-package.Rd @@ -71,6 +71,7 @@ Econometrica, Vol. 83, No. 3 (May, 2015), 897-941. \doi{10.3982/ECTA12299} Useful links: \itemize{ \item \url{https://github.com/handcock/rpm} + \item Report bugs at \url{https://github.com/handcock/rpm/issues} } } diff --git a/man/rpm.Rd b/man/rpm.Rd index de81329..b384461 100644 --- a/man/rpm.Rd +++ b/man/rpm.Rd @@ -114,7 +114,7 @@ The pairings are determined by the \code{pair_id} variable in \code{Xdata}. If that variable is NA then the women is 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{ +\describe{ \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 diff --git a/man/rpm_MLPLE.Rd b/man/rpm_MLPLE.Rd index 1e0561f..940967e 100644 --- a/man/rpm_MLPLE.Rd +++ b/man/rpm_MLPLE.Rd @@ -112,7 +112,7 @@ The pairings are determined by the \code{pair_id} variable in \code{Xdata}. If that variable is NA then the women is 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{ +\describe{ \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 diff --git a/man/summary_rpm.Rd b/man/summary_rpm.Rd index e83617c..5e7bbd3 100644 --- a/man/summary_rpm.Rd +++ b/man/summary_rpm.Rd @@ -91,7 +91,7 @@ The pairings are determined by the \code{pair_id} variable in \code{Xdata}. If that variable is NA then the women is 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{ +\describe{ \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