[R-package] DESCRIPTION changes to address CRAN feedback (#3298)

* [R-package] DESCRIPTION changes to address CRAN feedback * CRAN likes single quotes * the regex rules for Rbuildignore are weird * ugh Rbuildignore * how does this wooork * just remove cran-comments.md in script * adding Biarch back * Update R-package/cran-comments.md Co-authored-by: Nikita Titov <[email protected]> * add submission 3 notes * Update R-package/cran-comments.md Co-authored-by: Nikita Titov <[email protected]>
microsoft · Aug 13, 2020 · 1804fd1 · 1804fd1
1 parent 2b0a09f
commit 1804fd1
Show file tree

Hide file tree

Showing 4 changed files with 154 additions and 5 deletions.
diff --git a/R-package/.Rbuildignore b/R-package/.Rbuildignore
@@ -1,7 +1,8 @@
 ^build_r.R$
 \.gitkeep$
-^docs$
+^docs/.*$
 ^pkgdown$
+^cran-comments\.md$
 
 # Objects created by compilation
 ^.*\.o

diff --git a/R-package/DESCRIPTION b/R-package/DESCRIPTION
@@ -9,21 +9,21 @@ Authors@R: c(
     person("Yachen", "Yan", role = c("ctb")),
     person("James", "Lamb", email="[email protected]", role = c("ctb"))
     )
-Description: Tree based algorithms can be improved by introducing boosting frameworks. LightGBM is one such framework, and this package offers an R interface to work with it.
+Description: Tree based algorithms can be improved by introducing boosting frameworks. 'LightGBM' is one such framework, and this package offers an R interface to work with it.
     It is designed to be distributed and efficient with the following advantages:
         1. Faster training speed and higher efficiency.
         2. Lower memory usage.
         3. Better accuracy.
         4. Parallel learning supported.
         5. Capable of handling large-scale data.
-    In recognition of these advantages, LightGBM has been widely-used in many winning solutions of machine learning competitions.
-    Comparison experiments on public datasets suggest that LightGBM can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. In addition, parallel experiments suggest that in certain circumstances, LightGBM can achieve a linear speed-up in training time by using multiple machines.
+    In recognition of these advantages, 'LightGBM' has been widely-used in many winning solutions of machine learning competitions.
+    Comparison experiments on public datasets suggest that 'LightGBM' can outperform existing boosting frameworks on both efficiency and accuracy, with significantly lower memory consumption. In addition, parallel experiments suggest that in certain circumstances, 'LightGBM' can achieve a linear speed-up in training time by using multiple machines.
 Encoding: UTF-8
 License: MIT + file LICENSE
 URL: https://github.com/Microsoft/LightGBM
 BugReports: https://github.com/Microsoft/LightGBM/issues
 NeedsCompilation: yes
-Biarch: false
+Biarch: true
 Suggests:
     processx,
     testthat

diff --git a/R-package/cran-comments.md b/R-package/cran-comments.md
@@ -0,0 +1,147 @@
+# CRAN Submission History
+
+## v3.0.0-1 - Submission 3 - (August 12, 2020)
+
+### CRAN response
+
+Failing pre-checks.
+
+### `R CMD check` results
+
+* Debian: 1 NOTE
+
+    ```text
+    * checking CRAN incoming feasibility ... NOTE
+    Maintainer: ‘Guolin Ke <[email protected]>’
+
+    New submission
+
+    License components with restrictions and base license permitting such:
+      MIT + file LICENSE
+    ```
+
+* Windows: 1 ERROR, 1 NOTE
+
+    ```text
+    * checking CRAN incoming feasibility ... NOTE
+    Maintainer: ‘Guolin Ke <[email protected]>’
+
+    New submission
+
+    License components with restrictions and base license permitting such:
+      MIT + file LICENSE
+
+    ** running tests for arch 'i386' ... [9s] ERROR
+      Running 'testthat.R' [8s]
+    Running the tests in 'tests/testthat.R' failed.
+    Complete output:
+      > library(testthat)
+      > library(lightgbm)
+      Loading required package: R6
+      >
+      > test_check(
+      +     package = "lightgbm"
+      +     , stop_on_failure = TRUE
+      +     , stop_on_warning = FALSE
+      + )
+      -- 1. Error: predictions do not fail for integer input (@test_Predictor.R#7)  --
+      lgb.Dataset.construct: cannot create Dataset handle
+      Backtrace:
+       1. lightgbm::lgb.train(...)
+       2. data$construct()
+    ```
+
+### Maintainer Notes
+
+The "checking CRAN incoming feasibility" NOTE can be safely ignored. It only shows up the first time you submit a package to CRAN.
+
+So the only thing I see broken right now is the test error on 32-bit Windows. This is documented in https://github.com/microsoft/LightGBM/issues/3187.
+
+## v3.0.0-1 - Submission 2 - (August 10, 2020)
+
+### CRAN response
+
+Failing pre-checks.
+
+### `R CMD check` results
+
+* Debian: 2 NOTEs
+
+    ```text
+    * checking CRAN incoming feasibility ... NOTE
+    Maintainer: ‘Guolin Ke <[email protected]>’
+
+    New submission
+
+    License components with restrictions and base license permitting such:
+      MIT + file LICENSE
+
+    Non-standard files/directories found at top level:
+    ‘cran-comments.md’ ‘docs’
+    ```
+
+* Windows: 1 ERROR, 2 NOTEs
+
+    ```text
+    * checking CRAN incoming feasibility ... NOTE
+    Maintainer: 'Guolin Ke <[email protected]>'
+
+    New submission
+
+    License components with restrictions and base license permitting such:
+      MIT + file LICENSE
+
+    * checking top-level files ... NOTE
+    Non-standard files/directories found at top level:
+      'cran-comments.md' 'docs'
+
+    ** checking whether the package can be loaded ... ERROR
+    Loading this package had a fatal error status code 1
+    Loading log:
+    Error: package 'lightgbm' is not installed for 'arch = i386'
+    Execution halted
+    ```
+
+### Maintainer Notes
+
+Seems removing `Biarch` field didn't work. Noticed this in the install logs:
+
+> Warning: this package has a non-empty 'configure.win' file, so building only the main architecture
+
+Tried adding `Biarch: true` to `DESCRIPTION` to overcome this.
+
+NOTE about non-standard files was the result of a mistake in `.Rbuildignore` syntax, and something strange with how `cran-comments.md` line in `.Rbuildignore`  was treated. Updated `.Rbuildignore` and added an `rm cran-comments.md` to `build-cran-package.sh`.
+
+## v3.0.0-1 - Submission 1 - (August 9, 2020)
+
+### CRAN response
+
+Failing pre-checks.
+
+### `R CMD check` results
+
+* Debian: 1 NOTE
+
+    ```text
+    Possibly mis-spelled words in DESCRIPTION:
+      LightGBM (12:88, 19:41, 20:60, 20:264)
+    ```
+
+* Windows: 1 ERROR, 1 NOTE
+
+    ```text
+    Possibly mis-spelled words in DESCRIPTION:
+      LightGBM (12:88, 19:41, 20:60, 20:264)
+
+    ** checking whether the package can be loaded ... ERROR
+    Loading this package had a fatal error status code 1
+    Loading log:
+    Error: package 'lightgbm' is not installed for 'arch = i386'
+    Execution halted
+    ```
+
+### Maintainer Notes
+
+Thought the issue on Windows was caused by `Biarch: false` in `DESCRIPTION`. Removed `Biarch` field.
+
+Thought the "misspellings" issue could be resolved by adding single quotes around LightGBM, like `'LightGBM'`.
diff --git a/build-cran-package.sh b/build-cran-package.sh
@@ -30,6 +30,7 @@ cd ${TEMP_R_DIR}
     rm -r src/cmake/
     rm -r inst/
     rm -r pkgdown/
+    rm cran-comments.md
     rm AUTOCONF_UBUNTU_VERSION
     rm recreate-configure.sh