sfsfs

Author: svmiller

R/add_atop_alliance.R

@@ -58,18 +58,26 @@
 #' directed dyad-year and the merging proceeds without further consideration. If
 #' there are no instances in which `ccode1` is greater than `ccode2`, the data
 #' are assumed to be non-directed dyad-years and the behavior of this function
-#' hinges on the logical condition supplied to the `ndir` argument. If `ndir` is
-#' `TRUE` (default), the function assumes you are aware the data you have are
-#' non-directed while the alliance data are directed. It will then summarize the
-#' directed dyad-year data looking for the highest observed value in the
-#' dyad-year in either direction. In the above illustration, it would mean that
-#' the Belgium-France dyad would have a defense pledge in 1832 no matter how the
-#' non-directed dyad is entered in the data. If `ndir` is `FALSE`, the function
-#' performs a simple merge on matching dyad-year keys. In the above illustration,
-#' it would mean a Belgium-France dyad in 1832 would have no defense pledge
-#' because it was incidentally the case that the defense pledge that does appear
-#' in that dyad is made by the state with the higher state code. Use this
-#' argument with that in mind if your data are non-directed.
+#' hinges on the logical condition supplied to the `ndir` argument.
+#'
+#' - If `ndir` is `TRUE` (default): the function assumes you are aware the data
+#' you have are non-directed while the alliance data are directed. It will then
+#' summarize the directed dyad-year data looking for the highest observed value
+#' in the dyad-year in either direction. In the above illustration, it would mean
+#' that the Belgium-France dyad would have a defense pledge in 1832 no matter how
+#' the non-directed dyad is entered in the data. Belgium may not be pledging to
+#' defend France, but that is immaterial because the non-directed version of the
+#' directed dyad has a defense pledge in it.
+#'
+#' - If `ndir` is `FALSE`, the function performs a simple merge on matching
+#' dyad-year keys. In the above illustration, it would mean a Belgium-France
+#' dyad in 1832 would have no defense pledge because it was incidentally the
+#' case that the defense pledge that does appear in that dyad is made by the
+#' state with the higher state code. Use this argument with that in mind if your
+#' data are non-directed.
+#'
+#' The impetus behind this argument comes by way of an issue raised by Kevin
+#' Galambos and J. Andrés Gannon. You can [read about it here](https://github.com/svmiller/peacesciencer/issues/13).
 #'
 #' @author Steven V. Miller
 #'

cran-comments.md

@@ -8,6 +8,8 @@ R CMD check done via `devtools::check()`, resulting in 0 errors, 0 warnings, and
 
 `devtools::spell_check()` suggests several spelling errors. However, what I submit to CRAN includes only the false positives. Almost all of these false positives occur in the R Documentation files and concern proper nouns (e.g. data set authors) or peculiar terms that are unfamiliar in the R programming context (e.g. "dyad"). 
 
+`devtools::check(manual = TRUE, remote = TRUE, incoming = TRUE)` identified any URL redirect issues in advance of submission. This check is always the death of me. It did identify a note about the DOI being forbidden in the `inst/CITATION` file but my review of others who have received this note suggest it's not an issue for CRAN. The DOI itself is valid.
+
 ## Downstream dependencies
 
 There are no downstream dependencies to note.