From 4af8eaf697aa04e65a35af08be6abc13f25aee04 Mon Sep 17 00:00:00 2001 From: Benjamin Elbers Date: Fri, 15 Jun 2018 17:26:16 +0200 Subject: [PATCH] prepare CRAN submission --- DESCRIPTION | 2 +- R/mutual.R | 2 +- R/mutual_difference.R | 4 ++-- cran-comments.md | 16 +++------------- man/mutual_difference.Rd | 4 ++-- man/mutual_within.Rd | 2 +- 6 files changed, 10 insertions(+), 20 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b51efcf..c16d4c1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: segregation Type: Package Title: Entropy-Based Segregation Indices -Version: 0.0.1.9000 +Version: 0.1.0 Authors@R: person("Benjamin", "Elbers", email = "be2239@columbia.edu", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5392-3448")) Description: Computes entropy-based segregation indices, as developed by diff --git a/R/mutual.R b/R/mutual.R index 1c1793c..796fd0f 100644 --- a/R/mutual.R +++ b/R/mutual.R @@ -181,7 +181,7 @@ mutual_total <- function(data, group, unit, within = NULL, #' contained in \code{data}. Defines the second dimension #' over which segregation is computed. #' @param within A categorical variable or a vector of variables -#' contained in \code{data} that defines the within-segregation categoriess. +#' contained in \code{data} that defines the within-segregation categories. #' @param weight Numeric. Only frequency weights are allowed. #' (Default \code{NULL}) #' @param se If \code{TRUE}, standard errors are estimated via bootstrap. diff --git a/R/mutual_difference.R b/R/mutual_difference.R index e783d70..807d1a4 100644 --- a/R/mutual_difference.R +++ b/R/mutual_difference.R @@ -37,7 +37,7 @@ #' over which segregation is computed. #' @param weight Numeric. Only frequency weights are allowed. #' (Default \code{NULL}) -#' @param method Either "ipf" (the default) (Karmel and Machlachlan 1988), or +#' @param method Either "ipf" (the default) (Karmel and Maclachlan 1988), or #' "mrc" / "mrc_adjusted" (Mora and Ruiz-Castillo 2009). See below for an explanation. #' @param forward_only Only relevant for "ipf". If set to \code{TRUE}, the decomposition will #' only adjust the margins of \code{data2} to those \code{data1}, and not vice versa. This @@ -58,7 +58,7 @@ #' #' The sum of all rows following \code{diff} equal \code{diff}. #' -#' When using "ipf" or "mrc_adjusted", two additionals rows are reported: +#' When using "ipf" or "mrc_adjusted", two additional rows are reported: #' \code{additions} contains the change in M induces by \code{unit} and code{group} categories #' present in \code{data2} but not \code{data1}, and \code{removals} the reverse. #' diff --git a/cran-comments.md b/cran-comments.md index ae24b17..8963b6d 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,19 +1,9 @@ -This is the second resubmission. - -* added references to Description text - -## First resubmission. - -* fixed LICENSE file -* updated URLs in README - ## Test environments -* local OS X, R 3.4.4 -* CRAN win-builder +* local OS X, R 3.5.0 +* CRAN win-builder (NOTE: "Theil's" is not misspelled) +* ubuntu 14.04 (on travis-ci), R 3.5.0 ## R CMD check results No ERRORs, WARNINGSs, or NOTES. - - diff --git a/man/mutual_difference.Rd b/man/mutual_difference.Rd index a52d671..2ad762c 100644 --- a/man/mutual_difference.Rd +++ b/man/mutual_difference.Rd @@ -24,7 +24,7 @@ over which segregation is computed.} \item{weight}{Numeric. Only frequency weights are allowed. (Default \code{NULL})} -\item{method}{Either "ipf" (the default) (Karmel and Machlachlan 1988), or +\item{method}{Either "ipf" (the default) (Karmel and Maclachlan 1988), or "mrc" / "mrc_adjusted" (Mora and Ruiz-Castillo 2009). See below for an explanation.} \item{forward_only}{Only relevant for "ipf". If set to \code{TRUE}, the decomposition will @@ -52,7 +52,7 @@ Returns a data frame with columns \code{stat} and \code{est}. The data frame con The sum of all rows following \code{diff} equal \code{diff}. - When using "ipf" or "mrc_adjusted", two additionals rows are reported: + When using "ipf" or "mrc_adjusted", two additional rows are reported: \code{additions} contains the change in M induces by \code{unit} and code{group} categories present in \code{data2} but not \code{data1}, and \code{removals} the reverse. diff --git a/man/mutual_within.Rd b/man/mutual_within.Rd index 48f4781..23aaf42 100644 --- a/man/mutual_within.Rd +++ b/man/mutual_within.Rd @@ -19,7 +19,7 @@ contained in \code{data}. Defines the second dimension over which segregation is computed.} \item{within}{A categorical variable or a vector of variables -contained in \code{data} that defines the within-segregation categoriess.} +contained in \code{data} that defines the within-segregation categories.} \item{weight}{Numeric. Only frequency weights are allowed. (Default \code{NULL})}