Skip to content

Commit

Permalink
Convert \itemize to \describe tags
Browse files Browse the repository at this point in the history
to be consistent with CRAN
  • Loading branch information
handcock committed Apr 20, 2024
1 parent c293b74 commit d39a470
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Imports:
doFuture,
foreach
Encoding: UTF-8
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
4 changes: 2 additions & 2 deletions R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -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}.}
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion R/rpm.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion R/rpm_MLPLE.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion R/summary_rpm.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions man/fauxmatching.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/rpm-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/rpm.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/rpm_MLPLE.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/summary_rpm.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d39a470

Please sign in to comment.