Code Monkey home page Code Monkey logo

Comments (2)

cvitolo avatar cvitolo commented on June 19, 2024

Review 12.02.2021

If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form
authors (year) doi:...
authors (year) arXiv:...
authors (year, ISBN:...)
or if those are not available: <[https:...]https:...>
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
auto-linking.
(If you want to add a title as well please put it in quotes: "Title")

The following text was added to the description field in the DESCRIPTION file:

The package is described in Vitolo et al. (2018) "Caliver: An R package for CALIbration and VERification of forest fire gridded model outputs" doi:10.1371/journal.pone.0189419.

Please add \value to .Rd files regarding exported methods and explain
the functions results in the documentation. Please write about the
structure of the output (class) and also what the output means. (If a
function does not return a value, please document that too, e.g.
\value{No return value, called for side effects} or similar)
Missing Rd-tags:
anomaly.Rd: \value
daily_clima.Rd: \value
get_fire_season.Rd: \value
get_perc_risk_index.Rd: \value
plot_pdf.Rd: \value
plot_percentile_map.Rd: \value
ranking.Rd: \value
read_risico_binary.Rd: \value

This was done by adding the description of return values (@return field).

You have examples for unexported functions.
Please either omit these examples or export these functions.
Used ::: in documentation:
man/classify_index.Rd:
rasterVis::levelplot(x, col.regions = caliver:::effis_palette)

The call to caliver:::effis_palette was removed.

Please always make sure to reset to user's options(), working directory
or par() after you changed it in examples and vignettes and demos.
e.g.: validate_fire_danger_levels.Rd
oldwd <- setwd("/scratch/mo/moc0/fire/")
...
setwd(oldwd)

Documentation is now independent of the working directory.

from caliver.

cvitolo avatar cvitolo commented on June 19, 2024

CRAN review passed, caliver is now on CRAN! https://cran.rstudio.com/web/packages/caliver/index.html

from caliver.

Related Issues (11)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.