search

ropensci / software-review

rOpenSci Software Peer Review.
291 stars 104 forks source link

rdbhapi : R package to simplify API access to data on higher education in Norway #443

Closed mni-hkdir closed 2 years ago

mni-hkdir commented 3 years ago

Submitting Author Name: Marija Ninic Submitting Author Github Handle: !--author1-->@makinin<!--end-author1-- Other Package Authors Github handles: (comma separated, delete if none) !--author-others-->@sigve-berge-hofland<!--end-author-others-- Repository: https://github.com/makinin/rdbhapi Version submitted: 2.1.0 Submission type: Standard Editor: !--editor-->@haozhu233<!--end-editor-- Reviewers: TBD

Language: en Archive: TBD Version accepted: TBD

Package: rdbhapi
Title: Interface to 'DBH-API' 
Version: 2.1.0
Authors@R: c(person(given = "Marija",family = "Ninic",role = c("cre", "aut"),email = "marija.ninic@nsd.no", comment=c(ORCID ="0000-0001-8484-5817")),person(given=c("Sigve", "Hofland"), family="Berge", role = "aut"))
Description: Downloads 'DBH-API'<https://dbh.nsd.uib.no/tjenester.action> data as dataframes. These data are in machine-readable format and provides information about education, finances, research and publications. 
License: MIT + file LICENSE
Encoding: UTF-8
RoxygenNote: 7.1.1
Imports: 
    httr,
    readr,
    rjson,
    jsonlite,
    rlang,
    stats
Suggests:
    spelling, 
    knitr,
    rmarkdown,
    testthat
VignetteBuilder: knitr
Language: en-US

Scope

Technical checks

Confirm each of the following by checking the box.

This package:

Publication options

MEE Options - [ x] The package is novel and will be of interest to the broad readership of the journal. - [ x] The manuscript describing the package is no longer than 3000 words. - [ x] You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see [MEE's Policy on Publishing Code](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/journal-resources/policy-on-publishing-code.html)) - (*Scope: Do consider MEE's [Aims and Scope](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/aims-and-scope/read-full-aims-and-scope.html) for your manuscript. We make no guarantee that your manuscript will be within MEE scope.*) - (*Although not required, we strongly recommend having a full manuscript prepared when you submit here.*) - (*Please do not submit your package separately to Methods in Ecology and Evolution*)

Code of conduct

noamross commented 3 years ago

@ropensci-review-bot assign @haozhu233 as editor

ropensci-review-bot commented 3 years ago

Assigned! @haozhu233 is now the editor

haozhu233 commented 3 years ago

Editor checks:

Editor comments

Hi @makinin, I'm your guest editor for the rdbhapi submission. I'm very sorry for the delay! I got dragged by many other things in my life. I'll help you move forward with the reviewing process as fast as I can.

I took a look at the package and I like its overall quality so far. I think the topic of this package is a good fit for ropensci in the data retrieval category and the existence of this package does make utilizing the DBH-API a lot easier (especially when I can't fully understand the Norwegian API documentation 😂). In terms of coding, I especially like how you use R's environment to host all the "private fields" of the API class if there is one. There are some small issues I found. If you can address them while I search for reviewers for you, it would be great and it would also help the reviewers finish their reviewing process.

I will start to search for reviewers and I will keep you posted.

Reviewers: Due date:

mni-hkdir commented 3 years ago

@haozhu233 Hello and thank you for your suggestions. I have fixed long code lines and run checks after that but I get the following error message Project file "rdbhapi.Rproj" is not a valid MSBuild project file which must be an XML in appveyor and do not know how to fix it. I have run codecov again but since it was a lot of chaneges since first version for two years ago I have to write new examples. Best regards, Marija

haozhu233 commented 3 years ago

No problem @makinin take your time! :)

For the appveyor issue, have you tried out https://github.com/krlmlr/r-appveyor? That might be helpful in this case.

haozhu233 commented 3 years ago

Hi @makinin, how's going with the rdbhapi package? Have you finished this round of updates? Feel free to let me know if I can provide any help or assistance. :)

mni-hkdir commented 3 years ago

Hi @haozhu233 , I followed your suggestions and I updated package. However although I add examples codecov return coverage 0 %
Best regards, Marija

ldecicco-USGS commented 2 years ago

@ropensci-review-bot check package

ropensci-review-bot commented 2 years ago

Thanks, about to send the query.

ropensci-review-bot commented 2 years ago

:rocket:

Error: Issue template has no 'repourl'

:wave:

mpadge commented 2 years ago

Sorry @ldecicco-USGS, the submission templates have changed somewhat since that submission. I've edited to new expected form, so should be okay to try again.

ldecicco-USGS commented 2 years ago

@ropensci-review-bot check package

ropensci-review-bot commented 2 years ago

Thanks, about to send the query.

ropensci-review-bot commented 2 years ago

:rocket:

Editor check started

:wave:

ropensci-review-bot commented 2 years ago

Checks for [rdbhapi (v2.1.0)]()

git hash: a72d1d03

Important: All failing checks above must be addressed prior to proceeding

Package License: MIT + file LICENSE

1. Statistical Properties

This package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing.

Details of statistical properties (click to open)

The package has: - code in R (100% in 5 files) and - 2 authors - 1 vignette - no internal data file - 6 imported packages - 13 exported functions (median 13 lines of code) - 21 non-exported functions in R (median 11 lines of code) --- Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages The following terminology is used: - `loc` = "Lines of Code" - `fn` = "function" - `exp`/`not_exp` = exported / not exported The final measure (`fn_call_network_size`) is the total number of calls between functions (in R), or more abstract relationships between code objects in other languages. Values are flagged as "noteworthy" when they lie in the upper or lower 5th percentile. |measure | value| percentile|noteworthy | |:-----------------------|-----:|----------:|:----------| |files_R | 5| 29.8| | |files_vignettes | 0| 0.0|TRUE | |files_tests | 3| 71.1| | |loc_R | 334| 31.6| | |loc_tests | 26| 13.6| | |num_vignettes | 1| 60.7| | |n_fns_r | 34| 35.6| | |n_fns_r_exported | 13| 51.1| | |n_fns_r_not_exported | 21| 32.2| | |n_fns_per_file_r | 4| 56.5| | |num_params_per_fn | 1| 1.1|TRUE | |loc_per_fn_r | 12| 52.1| | |loc_per_fn_r_exp | 13| 32.2| | |loc_per_fn_r_not_exp | 11| 51.8| | |rel_whitespace_R | 19| 35.9| | |rel_whitespace_tests | 42| 68.6| | |doclines_per_fn_exp | 11| 2.0|TRUE | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 14| 31.0| | ---

1a. Network visualisation

Click to see the interactive network visualisation of calls between objects in package

2. goodpractice and other checks

Details of goodpractice and other checks (click to open)

--- #### 3b. `goodpractice` results #### `R CMD check` with [rcmdcheck](https://r-lib.github.io/rcmdcheck/) R CMD check generated the following note: 1. checking dependencies in R code ... NOTE Namespace in Imports field not imported from: ‘jsonlite’ All declared Imports should be used. R CMD check generated the following check_fails: 1. description_url 2. description_bugreports 3. rcmdcheck_imports_not_imported_from #### Test coverage with [covr](https://covr.r-lib.org/) Package coverage: 0 The following files are not completely covered by tests: file | coverage --- | --- R/DBH_api_tabell.R | 0% R/DBH_cache.R | 0% R/DBH_metadata.R | 0% R/DBH_token.R | 0% #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) The following function have cyclocomplexity >= 15: function | cyclocomplexity --- | --- dbh_cache | 17 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found the following 4 potential issues: message | number of times --- | --- Lines should not be more than 80 characters. | 4

Package Versions

|package |version | |:--------|:---------| |pkgstats |0.0.2.72 | |pkgcheck |0.0.2.107 |

Editor-in-Chief Instructions:

Processing may not proceed until the items marked with :heavy_multiplication_x: have been resolved.

haozhu233 commented 2 years ago

@makinin Hi Marija, sorry for the long delay. For some reason I didn't see your reply.

In terms of the coverage issue, I noticed that the codecov.yml was changed since the last working check. Can you try to put back this removed line and see how it goes?

https://github.com/makinin/rdbhapi/blob/4dfe1f52b26c69c381b851df9290d8afb990a84c/codecov.yml#L14

emilyriederer commented 2 years ago

Hi @makinin ! We are doing a sweep of stale review issues. Since this review has been open and inactive for so long, much may have changed including author, editor, and reviewer bandwidth and ever-evolving rOpenSci best practices. As such, I'm closing this issue. If you still have interest and capacity, we would welcome you to open a new submission issue!