search

cont-limno / LAGOSNE

Interface to the LAke multi-scaled GeOSpatial & temporal database :earth_americas:
https://cont-limno.github.io/LAGOSNE/
15 stars 8 forks source link

Create a `citation` function/file #1

Closed jsta closed 8 years ago

jsta commented 8 years ago

See http://r-pkgs.had.co.nz/inst.html#inst-citation

jsta commented 8 years ago

Per the "LAGOS ideas document" print citation information on package load?

To display an informative message when the package loads. This might make usage conditions clear, or display useful tips. Startup messages is one place where you should use .onAttach() instead of .onLoad(). To display startup messages, always use packageStartupMessage(), and not message(). (This allows suppressPackageStartupMessages() to selectively suppress package startup messages).

> .onAttach <- function(libname, pkgname) {
  packageStartupMessage("Welcome to my package")
}
limnoliver commented 8 years ago

Pointing users to the database paper - something that won't necessarily be in the cite() function - might be nice.