Skip to content

Commit

Permalink
Adjustments for CRAN notes
Browse files Browse the repository at this point in the history
  • Loading branch information
1beb committed Feb 15, 2024
1 parent 7541cbb commit c103d5b
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 29 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Authors@R: c(
person("Brandon", "Bertelsen", , "[email protected]", role = c("aut", "cre")),
person("Santiago", "Olivella", , "[email protected]", role = "aut"),
person("Evan", "Rosenman", , "[email protected]", role = "aut"),
person("Alex", "Rossell Hayes", "[email protected]", role = "aut"),
person("Alex", "Rossell Hayes", , "[email protected]", role = "aut"),
person("Kosuke", "Imai", , "[email protected]", role = "aut")
)
Description: Predicts individual race/ethnicity using surname, first name,
Expand Down
4 changes: 0 additions & 4 deletions R/RcppExports.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
#' @param middle_name See last_name
#' @param geo Integer vector of geographic units for each record. Must match column number in N_rg
#' @param N_rg Integer matrix of race | geography counts in census (geograpgies in columns).
#' @param M_rs Integer matrix of race | surname counts in dictionary (surnames in columns).
#' @param M_rf Same as `M_rs`, but for first names (can be empty matrix for surname only models).
#' @param M_rm Same as `M_rs`, but for middle names (can be empty matrix for surname, or surname and first name only models).
#' @param alpha Numeric matrix of race | geography prior probabilities.
#' @param pi_s Numeric matrix of race | surname prior probabilities.
#' @param pi_f Same as `pi_s`, but for first names.
Expand All @@ -19,7 +16,6 @@
#' @param which_names Integer; 0=surname only. 1=surname + first name. 2= surname, first, and middle names.
#' @param samples Integer number of samples to take after (in total)
#' @param burnin Integer number of samples to discard as burn-in of Markov chain
#' @param me_race Boolean; should measurement error in race | geography be corrected?
#' @param race_init Integer vector of initial race assignments
#' @param verbose Boolean; should informative messages be printed?
#'
Expand Down
12 changes: 6 additions & 6 deletions R/predict_race.R
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@
#' Must be an integer vector, with 1=white, 2=black, 3=hispanic, 4=asian, and
#' 5=other. Defaults to values obtained using \code{model="BISG_surname"}.
#' @param control List of control arguments only used when \code{model="fBISG"}, including
#' \itemize{
#' \item{iter}{ Number of MCMC iterations. Defaults to 1000.}
#' \item{burnin}{ Number of iterations discarded as burnin. Defaults to half of \code{iter}.}
#' \item{verbose}{ Print progress information. Defaults to \code{TRUE}.}
#' \item{me.correct}{ Boolean. Should the model correcting measurement error for \code{races|geo}? Defaults to \code{TRUE}.}
#' \item{seed}{ RNG seed. If \code{NULL}, a seed is generated and returned as an attribute for reproducibility.}
#' \describe{
#' \item{iter}{Number of MCMC iterations. Defaults to 1000.}
#' \item{burnin}{Number of iterations discarded as burnin. Defaults to half of \code{iter}.}
#' \item{verbose}{Print progress information. Defaults to \code{TRUE}.}
#' \item{me.correct}{Boolean. Should the model correct measurement error for \code{races|geo}? Defaults to \code{TRUE}.}
#' \item{seed}{RNG seed. If \code{NULL}, a seed is generated and returned as an attribute for reproducibility.}
#' }
#'
#' @return Output will be an object of class \code{data.frame}. It will
Expand Down
1 change: 1 addition & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
0 errors | 0 warnings | 1 note

* This is a new release.
* Note is related to file size which cannot be reduced.
12 changes: 6 additions & 6 deletions man/predict_race.Rd

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

8 changes: 0 additions & 8 deletions man/sample_me.Rd

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

4 changes: 0 additions & 4 deletions src/sample_me.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
//' @param middle_name See last_name
//' @param geo Integer vector of geographic units for each record. Must match column number in N_rg
//' @param N_rg Integer matrix of race | geography counts in census (geograpgies in columns).
//' @param M_rs Integer matrix of race | surname counts in dictionary (surnames in columns).
//' @param M_rf Same as `M_rs`, but for first names (can be empty matrix for surname only models).
//' @param M_rm Same as `M_rs`, but for middle names (can be empty matrix for surname, or surname and first name only models).
//' @param alpha Numeric matrix of race | geography prior probabilities.
//' @param pi_s Numeric matrix of race | surname prior probabilities.
//' @param pi_f Same as `pi_s`, but for first names.
Expand All @@ -18,7 +15,6 @@
//' @param which_names Integer; 0=surname only. 1=surname + first name. 2= surname, first, and middle names.
//' @param samples Integer number of samples to take after (in total)
//' @param burnin Integer number of samples to discard as burn-in of Markov chain
//' @param me_race Boolean; should measurement error in race | geography be corrected?
//' @param race_init Integer vector of initial race assignments
//' @param verbose Boolean; should informative messages be printed?
//'
Expand Down

0 comments on commit c103d5b

Please sign in to comment.