myOpt: My Optimization Package

## Create a new package with RStudio

# Package setup -----------------------------------------------------------

## Use version control
install.packages("usethis")
usethis::use_git_config(
  scope = "project",
  user.name = "Luca Aiello",
  user.email = "l.aiello4@campus.unimib.it"
)
usethis::use_git()

# avoid problem with the dev scripts: dev/package-utility.R (this file)
dir.create("dev")
# save this file in `dev` as `setup.R`
usethis::use_build_ignore("dev")
# now you can save or move this file in "dev"

# Fill in the DESCRIPTION file
# rstudioapi::navigateToFile( "DESCRIPTION" )
usethis::use_description(
  list(
    Title = "My Optimization Package",
    `Authors@R` = c("person('Luca', 'Aiello', email = 'l.aiello4@campus.unimib.it', role = c('cre', 'aut'))",
                    "person('Fabio', 'Piacenza', email = 'f.piacenza1@campus.unimib.it', role = c('cre', 'aut'))"),
    Description = "A personalized way to optimize functions in R.",
    URL = "https://github.com/lucaaiello/myOpt"
  )
)
usethis::use_lgpl_license()       # You can set another license here
usethis::use_tidy_description()   # sort fields and packages

## Common tasks
usethis::use_readme_md( open = FALSE )
# usethis::use_code_of_conduct()
# usethis::use_lifecycle_badge( "Experimental" )
# usethis::use_news_md( open = FALSE )


## Use tests: if you want to use tests
# usethis::use_testthat()
# installed.packages("devtools")

# Some useful keyboard shortcuts for package authoring:
#
#   Install Package:           'Ctrl + Shift + B' the current package we are working on
#   Source as package:         'Ctrl + Shift + L'
#   Check Package:             'Ctrl + Shift + E'
#   Test Package:              'Ctrl + Shift + T'


# Develop -----------------------------------------------------------------


## Add a package
usethis::use_package( "dplyr" )
# remeber to add it to ROXYGEN or NAMESPACE:
#' @import dplyr  # ROXYGEN
#' import(dplyr)  # NAMESPACE

## If you want to use roxygen, enable ROXYGEN in the project.
# Menu: tools > Project options > build tools > generate the documentation with roxygen
usethis::use_namespace(roxygen = TRUE)
devtools::document() # to fill NAMESPACE and documentation with ROXYGEN comments
# or roxygen2::roxygenise() # converts roxygen comments to .Rd files.
# or [Ctrl + Shift + D] in RStudio

# To create the documentations for the created functions: Ctrl + Shift + Alt + r

## Build or load
# Load the package [CTRL + SHIFT + L] or install-and-reload [CTRL + SHIFT + B]

## Check the package for Cran or [CTRL + SHIFT + E]
devtools::check(document = FALSE) # check the package

## Add internal datasets
## If you want to provide data along with your package
usethis::use_data_raw( name = "my_dataset", open = FALSE )

# Tests
## Add one line by test you want to create
usethis::use_test( "linear_gd_optim" )
usethis::use_test( "linear_sd_optim" )


## Vignette
usethis::use_vignette("myOpt_usage")
devtools::build_vignettes()
# Install the package and see it with `vignette("ThisTidyPackage")`
# List your vignettes: vignette(package = 'cancRFDS')
# Install your package manually: devtools::install(build_vignettes = TRUE)

# Deploy ------------------------------------------------------------------

# devtools::missing_s3()
#
# devtools::check()
# rhub::check_for_cran()