ropensci / allodb

An R package for biomass estimation at extratropical forest plots.
https://docs.ropensci.org/allodb/
GNU General Public License v3.0
36 stars 11 forks source link

Fix documentation #122

Closed maurolepore closed 3 years ago

maurolepore commented 3 years ago

Follow up https://github.com/forestgeo/allodb/pull/121#issuecomment-771184271 See the body of my first commie (i.e. expand ... below).

Is this better now?

I still see some notes but no error or warning -- we are getting there :-)

You may find this useful: https://r-pkgs.org/r-cmd-check.html#check-checks

── R CMD check results ────────────────────────────────── allodb 1.0.0.9000 ────
Duration: 56.9s

> checking top-level files ... NOTE
  Non-standard file/directory found at top level:
    ‘README_files’

> checking R code for possible problems ... NOTE
  illustrate_allodb: no visible binding for global variable ‘dbh’
  illustrate_allodb: no visible binding for global variable ‘agb’
  illustrate_allodb: no visible binding for global variable ‘equation’
  new_equations: no visible binding for global variable ‘ref_id’
  new_equations: no visible binding for global variable
    ‘dependent_variable’
  new_equations: no visible binding for global variable ‘equation_id’
  new_equations: no visible binding for global variable
    ‘independent_variable’
  new_equations : <anonymous>: no visible binding for global variable
    ‘Lon’
  new_equations : <anonymous>: no visible binding for global variable
    ‘Lat’
  new_equations: no visible binding for global variable ‘equations’
  resample_agb: no visible binding for global variable ‘resample’
  weight_allom : <anonymous>: no visible binding for global variable
    ‘Lon’
  weight_allom : <anonymous>: no visible binding for global variable
    ‘Lat’
  weight_allom: no visible binding for global variable ‘zone1’
  weight_allom : compare_koppen: no visible binding for global variable
    ‘zone2’
  Undefined global functions or variables:
    Lat Lon agb dbh dependent_variable equation equation_id equations
    independent_variable ref_id resample zone1 zone2

0 errors ✓ | 0 warnings ✓ | 2 notes x

R CMD check succeeded
cpiponiot commented 3 years ago

That's great, thanks a lot! I'll try to fix the notes, but can the package be submitted even if the CMD checks give notes?

maurolepore commented 3 years ago

All notes are now fixed via https://github.com/forestgeo/allodb/pull/123.

There is no automated barrier to submitting a package to rOpenSci. But editors and reviewers stick to the documented guidelines, so it is easy for us to know exactly what kinds of problems they will see. Given that we have that knowledge, do we want them to point them or us to catch them first? If we fix predictable problems, I think the reviewers will be more able to give more interesting feedback.

I would walk through the guidelines for authors, editors, and reviewers and only then submit. I can help a lot with this but I don't want to get in your way. Feel free to do as much or little as your energy allows, and let me know how I can help.

https://devguide.ropensci.org/

cpiponiot commented 3 years ago

Thanks for fixing the notes! And you're right, we'll go through the guidelines with Erika to check that everything corresponds to rOpenSci standards before submitting and ask you if we have any doubt.