Skip to content

Commit d39a470

Browse files
committed
Convert \itemize to \describe tags
to be consistent with CRAN
1 parent c293b74 commit d39a470

10 files changed

+12
-11
lines changed

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ Imports:
3636
doFuture,
3737
foreach
3838
Encoding: UTF-8
39-
RoxygenNote: 7.2.3
39+
RoxygenNote: 7.3.1

R/data.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
#' 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.
2222
#' \code{Zdata} is for men. Each row is a man, each column is a variable on that men
2323
#' The men's ID variable is called \code{pid}.
24-
#' \itemize{
24+
#' \describe{
2525
#' \item{pair_id}{ The ID of the person's partner. This is in both \code{Xdata} and \code{Zdata}.}
2626
#' \item{sampled}{ The indicator that the person was sampled directly (as distinct from being included as the match of a directly sampled
2727
#' person. All single people are directly sampled. This is in both \code{Xdata} and \code{Zdata}.}
@@ -31,7 +31,7 @@
3131
#' If that variable is NA then the women is
3232
#' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
3333
#' Weights are specified by three optional variables in \code{Xdata}.
34-
#' \itemize{
34+
#' \describe{
3535
#' \item{X_w}{The weight variable for women. The sum of the weights of the sampled women is the
3636
#' number of women in the population.}
3737
#' \item{Z_w}{The weight variable for men. The sum of the weights of the sampled men is the

R/rpm.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
#' If that variable is NA then the women is
5353
#' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
5454
#' Weights are specified by three optional variables in \code{Xdata}.
55-
#' \itemize{
55+
#' \describe{
5656
#' \item{X_w}{: This is character string of the name of the weight variable for women. The sum of the weights should be the
5757
#' number of women in the population.}
5858
#' \item{Z_w}{: This is character string of the name of the weight variable for men. The sum of the weights should be the

R/rpm_MLPLE.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
#' If that variable is NA then the women is
5353
#' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
5454
#' Weights are specified by three optional variables in \code{Xdata}.
55-
#' \itemize{
55+
#' \describe{
5656
#' \item{X_w}{: This is character string of the name of the weight variable for women. The sum of the weights should be the
5757
#' number of women in the population.}
5858
#' \item{Z_w}{: This is character string of the name of the weight variable for men. The sum of the weights should be the

R/summary_rpm.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
#' If that variable is NA then the women is
4949
#' assumed to be single. If men are listed in \code{Zdata} and are not partnered then they are assumed single.
5050
#' Weights are specified by three optional variables in \code{Xdata}.
51-
#' \itemize{
51+
#' \describe{
5252
#' \item{X_w}{: This is character string of the name of the weight variable for women. The sum of the weights should be the
5353
#' number of women in the population.}
5454
#' \item{Z_w}{: This is character string of the name of the weight variable for men. The sum of the weights should be the

man/fauxmatching.Rd

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rpm-package.Rd

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rpm.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/rpm_MLPLE.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/summary_rpm.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)