ipeadata-lab / ipeaplot

ipeaplot: criando graficos no padrão editorial do Ipea
https://ipeadata-lab.github.io/ipeaplot/
Other
1 stars 0 forks source link

CRAN: fix and resubmit #54

Closed cavalcanti1985 closed 2 months ago

cavalcanti1985 commented 3 months ago

@PedroJorge7, correções solicitadas pelo pessoal do CRAN:


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")

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:
      ipea_pal.Rd: \value

\dontrun{} should only be used if the example really cannot be executed
(e.g. because of missing additional software, missing API keys, ...) by
the user. That's why wrapping examples in \dontrun{} adds the comment
("# Not run:") as a warning for the user. Does not seem necessary.
Please replace \dontrun with \donttest.
Please unwrap the examples if they are executable in < 5 sec, or replace
dontrun{} with \donttest{}.
-> man/save_eps.Rd

Please ensure that your functions do not write by default or in your
examples/vignettes/tests in the user's home filespace (including the
package directory and getwd()). This is not allowed by CRAN policies.
Please omit any default path in writing functions. In your
examples/vignettes/tests you can write to tempdir(). -> man/save_eps.Rd

Please always make sure to reset to user's options(), working directory
or par() after you changed it in examples and vignettes and demos.
-> inst/doc/intro_ipeaplot.R
e.g.:
oldpar <- par(mfrow = c(1,2))
...
par(oldpar)
cavalcanti1985 commented 2 months ago

@PedroJorge7 , temos que colocar a refrência ao manual do editorial no DESCRIPTION file:

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")

O manual é este aqui: https://repositorio.ipea.gov.br/handle/11058/3101.

cavalcanti1985 commented 2 months ago

No fix 5, acho que você não restaurou as configurações originais, como pedido pelo CRAN:


# Salvar as configurações originais
oldpar <- par()

# Modificar as configurações conforme necessário
par(mfrow = c(1, 2))
# código para gerar gráficos...

# Restaurar as configurações originais
par(oldpar)
cavalcanti1985 commented 2 months ago

No fix 2, evite usar \itemize e \item, eles dão warning nos testes do CRAN:


#' @references
#' \itemize{
#'   \item{}{''Blue','Green','Orange','Pink','Green-Blue','Green-Blue-White','Red-Blue','Red-Blue-White',
#'   'Orange-Blue','Orange-Blue-White', 'Viridis','Inferno',
#'   'Magma','Plasma' and 'Cividis': https://pmassicotte.github.io/paletteer_gallery/}
#' }
#'
#' @return \code{ipea_palette} produces a character vector, \code{cv}, containing color hex codes.
#' This vector can be utilized to establish a custom color scheme for future graphics using \code{palette(cv)},
#' or it can be applied directly as a \code{col =} parameter in graphic functions or within \code{par}.
#'
cavalcanti1985 commented 2 months ago

Ressubmetido.