ropensci / comtradr

Functions for Interacting with the UN Comtrade API
https://docs.ropensci.org/comtradr
64 stars 17 forks source link

goodpractice #55

Closed pachadotdev closed 1 year ago

pachadotdev commented 1 year ago

excellent work! so far gp shows this:

── GP comtradr ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

It is good practice to

  ✖ write unit tests for all functions, and all package code in general. 47% of code lines are covered by test cases.

    R/ct_commodity_lookup.R:91:NA
    R/ct_commodity_lookup.R:92:NA
    R/ct_commodity_lookup.R:93:NA
    R/ct_commodity_lookup.R:94:NA
    R/ct_search.R:145:NA
    ... and 256 more lines

  ✖ avoid long code lines, it is bad for readability. Also, many people prefer editor windows that are about 80 characters wide. Try make your
    lines shorter than 80 characters

    inst/doc/comtradr-vignette.R:2:81
    inst/doc/comtradr-vignette.R:16:81
    inst/doc/comtradr-vignette.R:44:81
    inst/doc/comtradr-vignette.R:78:81
    inst/doc/comtradr-vignette.R:121:81
    ... and 25 more lines

  ✖ fix this R CMD check WARNING: LaTeX errors when creating PDF version. This typically indicates Rd problems. LaTeX errors found:
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── 
Error in .rs.normalizePath(marker$file, mustWork = TRUE) : 
  path[1]="./inst/doc/comtradr-vignette.R": No such file or directory
In addition: There were 17 warnings (use warnings() to see them)
datapumpernickel commented 1 year ago

I am tidying up a little. I think this test result is probably not up to date anymore, hence closing! :)