Submit to CRAN (#31)

Author: fleverest

.Rbuildignore

@@ -1,10 +1,13 @@
 ^.lintr$
 ^.pre-commit-config.yaml$
+^CRAN-RELEASE$
+^CRAN-SUBMISSION$
 ^LICENSE$
 ^README\.(Rmd|md|html)$
 ^\.github$
 ^_pkgdown\.yml$
 ^codecov\.yml$
+^cran-comments.md$
 ^docs$
 ^pkgdown$
 ^readme.bib$

.pre-commit-config.yaml

@@ -16,6 +16,7 @@ repos:
     -   id: spell-check
         exclude: >
           (?x)^(
+          CRAN-SUBMISSION|
           tests/data/.*|
           .*\.[rR]|
           .*\.feather|

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 0.1.0
+Date: 2023-03-07 14:07:19 UTC
+SHA: 72d54874e9749334942c7b474cda61e647acc60a

DESCRIPTION

@@ -1,15 +1,17 @@
 Package: prefio
 Title: Structures for Preference Data
 Description: Convenient structures for creating, sourcing, reading, writing
-  and manipulating ordinal preference data.
+  and manipulating ordinal preference data. Methods for writing to/from PrefLib
+  formats. See Nicholas Mattei and Toby Walsh "PrefLib: A Library of Preference
+  Data" (2013) <doi:10.1007/978-3-642-41575-3_20>.
 Authors@R: c(
   person("Floyd", "Everest", email = "me@floydeverest.com",
          role = c("aut", "cre"), comment = c(ORCID = "0000-0002-2726-6736")),
   person("Heather", "Turner", email = "ht@heatherturner.net",
          role = c("aut"), comment = c(ORCID = "0000-0002-1256-3375")),
   person("Damjan", "Vukcevic", email = "damjan@vukcevic.net",
          role = c("aut"), comment = c(ORCID = "0000-0001-7780-9586")))
-Version: 0.0.1
+Version: 0.1.0
 Depends: R (>= 2.10)
 LazyData: true
 License: GPL-3

NEWS.md

@@ -0,0 +1,3 @@
+# **prefio** 0.1.0
+
+* This is the initial release of **prefio**.

R/preflib.R

@@ -42,10 +42,6 @@
 #' \emph{Proceedings of Third International Conference on Algorithmic Decision
 #' Theory (ADT 2013)}. Lecture Notes in Artificial Intelligence, Springer.
 #'
-#' Caragiannis, I., Chatzigeorgiou, X, Krimpas, G. A., and Voudouris, A. A.
-#' (2017) Optimizing positional scoring rules for rank aggregation.
-#' In \emph{Proceedings of the 31st AAAI Conference on Artificial Intelligence}.
-#'
 #' Bennett, J. and Lanning, S. (2007) The Netflix Prize.
 #' \emph{Proceedings of The KDD Cup and Workshops}.
 #'
@@ -314,6 +310,7 @@ read_preflib <- function(file,
 #' @param related_files The list of all the data files related to this one,
 #' comma separated. If not provided, we check for the presence of
 #' `attr(x, "preflib")`, and if it exists we check for `RELATED FILES`.
+#' @return No return value. Output will be written to file or stdout.
 #'
 #' @export
 write_preflib <- function(x, # nolint: cyclocomp_linter

cran-comments.md

@@ -0,0 +1,60 @@
+# **prefio** 0.1.0
+
+This submission contains the initial release of **prefio**.
+
+## Addressing comments from previous submission:
+
+```
+If there are references describing the methods in your package, please
+add these in the description field of your DESCRIPTION file in the form
+authors (year) <doi:...>
+authors (year) <arXiv:...>
+authors (year, ISBN:...)
+or if those are not available: <https:...>
+with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
+auto-linking. (If you want to add a title as well please put it in
+quotes: "Title")
+```
+
+I have added one `doi` link to the DESCRIPTION, but there were two references
+in the `.Rd` files. The other reference is for the Netflix Prize, which refers
+only to the data fetched in the `dontrun` example.
+
+## `R CMD check` results
+
+#### GitHub Actions (via `usethis::use_github_action_check_standard()`):
+
+* ✅ macOS (12.6.2 21G320), R==4.2.2
+* ✅ Windows Server (2022 10.0.20348), R==4.2.2-win
+* ✅ Ubuntu (20.04.2), R==4.1.3
+* ✅ Ubuntu (20.04.2), R==4.2.2
+* ✅ Ubuntu (20.04.2), R==devel
+
+`0 errors ✔ | 0 warnings ✔ | 0 notes ✔`
+
+#### Other **Rhub** checks
+
+```R
+rhub::check_for_cran()
+```
+
+We see three notes:
+* One identifying this as a new submission:
+  ```
+  N  checking CRAN incoming feasibility
+     Maintainer: 'Floyd Everest <me@floydeverest.com>'
+
+     New submission
+  ```
+* Another which is unrelated to prefio:
+  ```
+  N  checking HTML version of manual
+     Skipping checking math rendering: package 'V8' unavailable
+  ```
+
+* The last is related to an [ongoing issue](https://github.com/r-hub/rhub/issues/503) on Rhub:
+  ```
+  N  checking for detritus in the temp directory
+     Found the following files/directories:
+       'lastMiKTeXException'
+  ```

inst/WORDLIST

@@ -25,6 +25,7 @@ cre
 damjan
 Damjan
 dat
+doi
 dplyr
 eee
 et
@@ -49,6 +50,7 @@ Lasser
 LazyData
 lgpl
 licensors
+macOS
 magrittr
 Mattei
 MERCHANTABILITY
@@ -65,6 +67,7 @@ preprended
 px
 recommender
 relicensing
+Rhub
 Roxygen
 RoxygenNote
 soi