usethis.R

# Usethis ----------------------------------------------------------------------

# library(usethis)

# Set up various packages ------------------------------------------------------

use_devtools()
use_roxygen_md()
use_revdep() # Maybe?

# Set up badges ----------------------------------------------------------------

use_bioc_badge()
use_lifecycle_badge(stage = "Experimental")

# Set up the NEWS file ---------------------------------------------------------

# use_news_md()

# Set up the DESCRIPTION file --------------------------------------------------

# Run this first, because use_description overwrites the file.
use_description(fields = list(
    Package = "scr",
    Title   = "Spatial scoring algorithms :: scorer",
    License = "MIT + file LICENSE",
    Date    = Sys.Date(),
    Description = paste0("A package that provides a framework to ease spatial ",
                         "scoring tasks. Commits are coming. Package scorer ",
                         "implements ideas nurtured while developping internal ",
                         "package glr for The Co-operators (CGIC). A much more ",
                         "general framework is adopted. This description will ",
                         "change in the future.")))

# desc functions does not overwrite file.
desc_set_version(version = package_version("0.0.0.9000"))
desc_set_authors(person(given = "Jean-Mathieu", family = "Potvin",
                        email = "jeanmathieupotvin@gmail.com",
                        role = c("cre", "aut", "cph")))
desc_add_urls(urls = "https://github.com/jeanmathieupotvin/scr")

# Add dependencies.
use_package("testthat", "Suggests")
use_package("methods", "Imports")
use_package("data.table", "Imports")
use_package("rgdal", "Imports")
use_package("sp", "Imports")

# Final checks.
desc_normalize()
desc_reorder_fields()

# Set up test files ------------------------------------------------------------

use_test("epsg_to_crs")
use_test("Geocodes-class")

# Set up data files ------------------------------------------------------------

# x <- 1
# y <- 2
# use_data(x, y)
jeanmathieupotvin/scr documentation built on Dec. 3, 2019, 8:53 p.m.