shipr

Install Package

# if missing package devtools
install.packages(devtools) 

# install this R package
devtools::install_github("mvisalli/shipr")

Use Package

• See R package vignette Basic Ship Reporting • shipr
• See website and code demonstration of making ship cards using parameterized flexdashboard.

Package Development

For reference, see:

• cheat sheet: package development
• book: R packages by Hadley Wickham

setup

Setup the skeleton of needed files in an existing directory:

devtools::setup()

functions

Muliple functions can live in a single *.R script inside the R/ folder:

• read.R:

  • read_ais_txt(): Read AIS text file

• analyze.R:

  • ship_limits(): Get breakdown of distance and time above/below speed limit

  • ship_segments(): Create line segments with speed for specific ship from AIS data

• viz.R:

  • map_ship_limits(): Interactive map of ship limits

  • map_ship_segments(): Interactive map of ship segments

  • ship_gauge(): Show gauge of ship performance

  • ship_box(): Show value box of ship performance

documentation

Generate the R documentation from roxygen2 comments above the R functions to be placed into the manual folder /man:

devtools::document()

data

Use raw data:

devtools::use_data_raw()

Move data files into data-raw/, then sbais.R to generate sbais.csv and load into data/ with:

usethis::use_data(sbais, overwrite = TRUE)

vignettes

devtools::use_vignette("intro")

packages

Create dependencies on packages so these get installed if missing. Updates the DESCRIPTION file:

usethis::use_package("dplyr")
usethis::use_package("leaflet")
usethis::use_package("lubridate")
usethis::use_package("purrr")
usethis::use_package("reader")
usethis::use_package("readr")
usethis::use_package("sf")
usethis::use_package("stringr")
usethis::use_package("units")

website

Build website into docs/ folder with pkgdown, to be hosted using Github Pages.

devtools::document()
pkgdown::build_site()

Structure reference listing with inst/_pkgdown.yml per:

• Introduction • pkgdown
• build_reference() • pkgdown

usethis::use_github_links()

✔ Setting URL field in DESCRIPTION to 'https://github.com/mvisalli/shipr'
✔ Setting BugReports field in DESCRIPTION to 'https://github.com/mvisalli/shipr/issues'

usethis::use_news_md()

✔ Writing 'NEWS.md'