cmipr - Client for Coupled Model Intercomparison Project (CMIP) data

[sckott]

Summary

• What does this package do? (explain in 50 words or less):

Client to work with CMIP data - downscaled climate and hydrology projections. Package lists avail. files, downloads and caches, and reads into raster objects.

• Paste the full DESCRIPTION file inside a code block below:

Package: cmipr
Type: Package
Title: Client for Coupled Model Intercomparison Project (CMIP) Data
Description: Client for Coupled Model Intercomparison Project (CMIP) data
		(<http://gdo-dcp.ucllnl.org/downscaled_cmip_projections/>).
		Data is stored on an FTP server, from which we provide
		functions to fetch data and return tidy data.
Version: 0.0.8.9310
Authors@R: person("Scott", "Chamberlain", role = c("aut", "cre"),
    email = "myrmecocystus@gmail.com")
License: MIT + file LICENSE
URL: https://github.com/ropenscilabs/cmipr
BugReports: https://github.com/ropenscilabs/cmipr/issues
VignetteBuilder: knitr
Imports:
    hoardr (>= 0.0.3),
    raster (>= 2.5-8),
    ncdf4 (>= 1.15),
    curl (>= 2.3),
    crul (>= 0.2.1.9100),
    tibble
Suggests:
    roxygen2 (>= 6.0.1),
    testthat,
    knitr,
    covr
RoxygenNote: 6.0.1
Remotes: ropensci/crul, ropensci/hoardr

• URL for the package (the development repository, not a stylized html page):

https://github.com/ropenscilabs/cmipr

• Who is the target audience?

People using climate projections for research - or studying climate change itself.

• Are there other R packages that accomplish the same thing? If so, what is different about yours?

https://github.com/JGCRI/RCMIP5 deals with CMIP data, but AFAICT only handles data after you have it on your machine. So that package and this one could be used together.

Requirements

Confirm each of the following by checking the box. This package:

• does not violate the Terms of Service of any service it interacts with.
• has a CRAN and OSI accepted license.
• contains a README with instructions for installing the development version.
• includes documentation with examples for all functions.
• contains a vignette with examples of its essential functions and uses.
• has a test suite.
• has continuous integration with Travis CI and/or another service.

Publication options

• Do you intend for this package to go on CRAN?
• Do you wish to automatically submit to the Journal of Open Source Software? If so:
  • The package contains a paper.md with a high-level description in the package root or in inst/.
  • The package is deposited in a long-term repository with the DOI:
  • (Do not submit your package separately to JOSS)

Detail

• Does R CMD check (or devtools::check()) succeed? Paste and describe any errors or warnings:

• Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:

• If this is a resubmission following rejection, please explain the change in circumstances:

• If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:

maybe https://github.com/bpbond since author of the above mentioned pkg

[maelle]

Editor checks:

• Fit: The package meets criteria for fit and overlap
• Automated tests: Package has a testing suite and is tested via Travis-CI or another CI service.
• License: The package has a CRAN or OSI accepted license
• Repository: The repository link resolves correctly
• Archive (JOSS only, may be post-review): The repository DOI resolves correctly
• Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

---

Editor comments

Thank you for your submission @sckott!

• RCMIP5 doc states "This package does not handle downloading (i.e. from nodes in the Earth System Grid Federation, http://esgf.org) the NetCDF data themselves. Sorry."
  So AFAICT too there's no overlap.

• Here is the output from goodpractice::gp().

It is good practice to

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

    R/cmip_fetch.R:24:NA
    R/cmip_fetch.R:25:NA
    R/cmip_fetch.R:26:NA
    R/cmip_read.R:41:NA
    R/cmip_read.R:43:NA
    ... and 8 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

    tests\testthat\test-cmip_fetch.R:4:1
    tests\testthat\test-cmip_read.R:4:1

where the long lines are only due to paths so you could only add "# nolint" at the end of these lines. 😉

• I identified one typo using devtools::spell_check(). "Reaa" in cmip_read.Rd:5,17 should be "Read".

---

Reviewers: @cvitolo @bpbond
Due date: 2017-03-13

[sckott]

thanks @masalmon will fix those things

[sckott]

@masalmon okay, those 2 thigns fixed

[maelle]

Thanks for accepting to review this package @cvitolo and @bpbond !

As a reminder here are links to the recently updated reviewing and packaging guides and to the review template. 

[maelle]

Hi @cvitolo and @bpbond ! Just a friendly reminder that your reviews are due on Monday, March 13.