Fixed misc CRAN issues #1260

jameslamb · 2018-03-13T05:23:01Z

Hello,

Thank you for this excellent package! @randxie and I would like to help you address #629 . We have some experience on the team working with the wonderful eccentricities of getting accepted to CRAN.

What I changed

Please consider this first PR to address some low-hanging notes and warnings. I've also attached a file with the state of the R CMD CHECK output showing the remaining notes and warnings that could be addressed in follow-up PRs.

r_cmd_check.log

As of this PR, R CMD CHECK for this package is down to 4 warnings and 3 notes.

Setup Information

I built the package by running the following from the repo root (I am on MacOS):

# Avoid errors related to AppleClang
export CXX=g++-7 CC=gcc-7

# Build some artifacts and document
Rscript -e "devtools::document()"

# Build the package tarball
cd R-package && Rscript build_package.R

# re-running documentation
Rscript -e "devtools::document()"

# Run R CMD CHECK and save results to file
R CMD CHECK lightgbm_2.1.0.tar.gz --as-cran --no-tests | tee r_cmd_check.log | cat

Please let me know if you have any questions or concerns! Please also let @randxie and I know if you are open to us making additional contributions to move this package toward CRAN-readiness.

Thanks!

-James

msftclas · 2018-03-13T05:23:12Z

All CLA requirements met.

jameslamb · 2018-03-13T05:24:12Z

R-package/DESCRIPTION

@@ -5,7 +5,7 @@ Version: 2.1.0
 Date: 2018-01-25
 Author: Guolin Ke <guolin.ke@microsoft.com>
 Maintainer: Guolin Ke <guolin.ke@microsoft.com>
-Description: LightGBM is a gradient boosting framework that uses tree based learning algorithms. 
+Description: Tree based algorithms can be improved by introducing boosting frameworks. LightGBM is one such framework.


This is in response to my least-favorite CRAN note. Your package's Description cannot start with the words "this package" or the name of the package.

@jameslamb I think this Description is too short. We can copy some from https://github.com/Microsoft/LightGBM/blob/master/README.md

@guolinke would you like me to make that change on this PR?

jameslamb · 2018-03-13T05:25:06Z

R-package/R/lgb.cv.R

-#' Main CV logic for LightGBM
-#'
+#' @title Main CV logic for LightGBM
+#' @name lgb.cv


this and lgb.train were getting grouped into a single documentation object with interwoven fields and R CMD CHECK complained about duplicated parameters. Using explicit @name elements avoids this

jameslamb · 2018-03-13T05:26:02Z

R-package/R/lightgbm.R

@@ -122,5 +122,28 @@ NULL
 # Various imports
 #' @import methods
 #' @importFrom R6 R6Class
-#' @useDynLib lightgbm
+#' @useDynLib lib_lightgbm


I was unable to build the package without making this change

jameslamb · 2018-03-13T05:26:19Z

R-package/R/lightgbm.R

+
+# Suppress false positive warnings from R CMD CHECK about
+# "unrecognized global variable"
+globalVariables(c(


This suppresses the R CMD CHECK warning about "unrecognized global variables"

jameslamb · 2018-03-13T05:27:37Z

R-package/src/Makevars

@@ -0,0 +1 @@
+


these address warnings from CRAN about having Make scripts with only LF characters in them

guolinke · 2018-03-13T07:32:09Z

ping @Laurae2

Laurae2 · 2018-03-13T22:48:08Z

@guolinke Please review the R-package description if you need to make changes on it.

You can compare with xgboost: https://github.com/dmlc/xgboost/blob/master/R-package/DESCRIPTION

chivee · 2018-03-14T07:35:50Z

@guolinke , adding @jameslamb and @Laurae2 to the author list will be nice.

@jameslamb , could you please also sign the CLA?

jameslamb · 2018-03-14T14:40:08Z

@chivee sorry for the delay. CLA signed!

jameslamb · 2018-03-15T06:48:46Z

R-package/DESCRIPTION

    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 being 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.


@guolinke per your request, I've included additional details here. You will recognize most of this from the README you linked me too. I also added the line about "this is the R interface to the project" following the way XGBoost structured their DESCRIPTION: https://cran.r-project.org/web/packages/xgboost/index.html

I think that's a good clarification for people, to say that LightGBM is a framework and this is the interface to it implemented in a particular programming language.

guolinke · 2018-03-16T05:26:44Z

@Laurae2 can you create another PR to add yourself and other R's contributors to author List ?

Laurae2 · 2018-03-18T16:42:44Z

@guolinke Yes I'll do when I get time tonight or next week.

Do I add both @jameslamb and @yanyachen ?

* Add authors #1260 * Add line break at the end of file

Jorgfevi · 2019-01-08T19:02:01Z

Hola , que tal amigos
Tengo el archivo .exe y el dll , pero a la hora de ejecutar o tratar de instalar la libreria R que dice build_r.R me sale un error como este
installation of package ‘C:/Users/BP2499/Documents/R/R-3.5.2/LightGbm/lightgbm_2.2.3.tar.gz’ had non-zero exit status
Desearia saber a que se debe este problema , o que pasos se siguen despues de tener el archivo .exe y .dll
Gracias

Fixed misc CRAN issues

d4b99fe

jameslamb commented Mar 13, 2018

View reviewed changes

Laurae2 approved these changes Mar 13, 2018

View reviewed changes

Laurae2 requested a review from guolinke March 13, 2018 22:47

Laurae2 mentioned this pull request Mar 14, 2018

R pkgdown support #1208

Closed

23 tasks

Added additional details to R-package DESCRIPTION

26466a5

jameslamb commented Mar 15, 2018

View reviewed changes

guolinke approved these changes Mar 15, 2018

View reviewed changes

guolinke merged commit 6bb61ea into microsoft:master Mar 16, 2018

jameslamb mentioned this pull request Mar 18, 2018

R package not building because of DCF error (DESCRIPTION file not formatted properly?) #1270

Closed

Laurae2 added a commit to Laurae2/LightGBM that referenced this pull request Mar 24, 2018

Add authors microsoft#1260

e319e00

Laurae2 mentioned this pull request Mar 24, 2018

Add R authors to the list #1285

Merged

guolinke pushed a commit that referenced this pull request Mar 25, 2018

Add R authors to the list (#1285)

eb913eb

* Add authors #1260 * Add line break at the end of file

lock bot locked as resolved and limited conversation to collaborators Mar 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed misc CRAN issues #1260

Fixed misc CRAN issues #1260

jameslamb commented Mar 13, 2018

msftclas commented Mar 13, 2018 •

edited

Loading

jameslamb Mar 13, 2018

guolinke Mar 14, 2018

jameslamb Mar 14, 2018

guolinke Mar 15, 2018

jameslamb Mar 13, 2018

jameslamb Mar 13, 2018

jameslamb Mar 13, 2018

jameslamb Mar 13, 2018

guolinke commented Mar 13, 2018

Laurae2 commented Mar 13, 2018

chivee commented Mar 14, 2018

jameslamb commented Mar 14, 2018

jameslamb Mar 15, 2018

guolinke commented Mar 16, 2018

Laurae2 commented Mar 18, 2018

Jorgfevi commented Jan 8, 2019

Fixed misc CRAN issues #1260

Fixed misc CRAN issues #1260

Conversation

jameslamb commented Mar 13, 2018

msftclas commented Mar 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guolinke commented Mar 13, 2018

Laurae2 commented Mar 13, 2018

chivee commented Mar 14, 2018

jameslamb commented Mar 14, 2018

Choose a reason for hiding this comment

guolinke commented Mar 16, 2018

Laurae2 commented Mar 18, 2018

Jorgfevi commented Jan 8, 2019

msftclas commented Mar 13, 2018 •

edited

Loading