Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenpp7 committed Feb 9, 2021
1 parent e2cbfa3 commit 646d061
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 3 deletions.
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Imports: dplyr,
stringr,
rmarkdown,
forcats,
tidyr
tidyr,
htmltools
Depends:
R (>= 2.10)
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import(dplyr)
import(forcats)
import(ggplot2)
import(googlesheets4)
import(htmltools)
import(leaflet)
import(rmarkdown)
import(scales)
Expand Down
13 changes: 13 additions & 0 deletions R/divewatchr.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#' divewatchr: A package for visualizing and exploring a SCUBA Diving Logbook
#'
#' This package allows for a thorough visualization of a diving logbook,
#' including spatio-temporal and categorical plots and maps.
#' The divewatchr package provides functions to read data from a diving logbook,
#' create informative maps, plots and data frames about the dataset and to create
#' descriptive reports about the diving logbook
#'
#'
#' @docType package
#' @name divewatchr
NULL
#> NULL
3 changes: 2 additions & 1 deletion R/logbook_map.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#' @author Ruben Perez Perez
#'
#' @import leaflet
#' @import htmltools
#'
#' @return Returns a map.
#'
Expand Down Expand Up @@ -49,7 +50,7 @@ m %>% addProviderTiles('Esri.WorldImagery') %>% # can also try CartoDB.VoyagerOn
ifelse(is.na(platformType), "", paste0(" - ", platformType)),
ifelse(is.na(diveType_3), "", paste0(" - ", diveType_3)))),
popupOptions = popupOptions(), # Change size, opacity, etc
label = lapply(labs, htmltools::HTML),
label = lapply(labs, HTML),
labelOptions = labelOptions(direction = "left",
opacity = 0.9,
style = list(
Expand Down
3 changes: 2 additions & 1 deletion files/overview.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ This data frame shows the diving logbook used. Personal information such as even
```{r echo=FALSE, rows.print=15}
load('data/scuba_clean.RData')
dplyr::transmute (scuba_clean, eventDate, locationID, locality, maximumDepth = maximumDepthInMeters, bottomTime, diveType, diveClass, platformType, region, country)
knitr::kable(dplyr::transmute (scuba_clean, eventDate, locationID, locality, maximumDepth = maximumDepthInMeters, bottomTime, diveType, diveClass, platformType, region, country))
```

***
Expand Down
13 changes: 13 additions & 0 deletions man/divewatchr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 646d061

Please sign in to comment.