Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CRAN submission #21

Closed
cvitolo opened this issue Feb 5, 2021 · 2 comments
Closed

CRAN submission #21

cvitolo opened this issue Feb 5, 2021 · 2 comments

Comments

@cvitolo
Copy link
Contributor

cvitolo commented Feb 5, 2021

Caliver is not yet on CRAN, a submission needs to be prepared.

@cvitolo
Copy link
Contributor Author

cvitolo commented Feb 15, 2021

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.

@cvitolo
Copy link
Contributor Author

cvitolo commented Feb 19, 2021

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

@cvitolo cvitolo closed this as completed Feb 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant