Skip to content

Commit

Permalink
prepare CRAN submission
Browse files Browse the repository at this point in the history
  • Loading branch information
elbersb committed Jun 15, 2018
1 parent 8ce5093 commit 4af8eaf
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 20 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]",
role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5392-3448"))
Description: Computes entropy-based segregation indices, as developed by
Expand Down
2 changes: 1 addition & 1 deletion R/mutual.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions R/mutual_difference.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
#'
Expand Down
16 changes: 3 additions & 13 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -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.


4 changes: 2 additions & 2 deletions man/mutual_difference.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/mutual_within.Rd

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

0 comments on commit 4af8eaf

Please sign in to comment.