added test, document datasets and functions

R/cum_dives.R

@@ -4,6 +4,7 @@
 #'
 #' This function creates some visualizations of the number of dives along time including a density plot and a fitted model 
 #' 
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/divecount_reg.R

@@ -4,6 +4,7 @@
 #'
 #' This function creates a barplot to visualize the number of dives per region
 #' 
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/divesite_depths.R

@@ -7,6 +7,7 @@
 #' 
 #' @param toofew number of logged dives per divesite under which a divesite is excluded 
 #' from the boxplot for having too few dives for an appropriate interpretation of the depth variation
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/divetypes.R

@@ -5,6 +5,7 @@
 #' This function creates a barplot to visualize the number of dives types "Course Leading", "Course Assistance", etc.
 #' 
 #' @param n.other number of dives under which a diveType is placed into the "Other" category.
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/divetypes_platform.R

@@ -4,6 +4,8 @@
 #'
 #' This function creates a barplot to visualize the number of dives per region and platform type "poolDive", "boatDive" or "shoreDive"
 #' 
+#' @param path directory location where the files will be read from or written into
+#' 
 #' @author Ruben Perez Perez
 #' 
 #' @import ggplot2

R/logbook_highlights.R

@@ -5,6 +5,7 @@
 #' This function creates a data frame to have an overview of some highlights of the diving logbook  
 #' such as number of recorded dives, maximum bottom time or maximum depth
 #' 
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/logbook_map.R

@@ -5,6 +5,7 @@
 #' This function creates a leaflet map to visualize the geographical coverage of the logbook together with some information on each dive such as
 #' Bottom Time, Max Depth, Date and Divesite
 #' 
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/logged_depths.R

@@ -5,6 +5,7 @@
 #' This function creates a scatterplot to visualize the maximum depths logged through time, offering a nice overview
 #' of the diving experience regarding depth
 #' 
+#' @param path directory location where the files will be read from or written into
 #' 
 #' @author Ruben Perez Perez
 #' 

R/scuba_cert.R

@@ -0,0 +1,14 @@
+#' Example of the certifications table
+#'
+#' A dataset containing an example of the certifications table, this table contains
+#' an example of what the column names must be and how the content must look like.
+#'
+#' @format A data frame with 4 rows and 5 variables:
+#' \describe{
+#'   \item{diverID}{the diver identifier linked to the certification}
+#'   \item{certificationName}{the name of the certification}
+#'   \item{certificationAgency}{the name or acronym of the agency that issued the certification}
+#'   \item{certificationDate}{the date when the certification was issued, in ISO8601}
+#'   \item{instructorID}{the diver identifier of the instructor who taught the course and issued the certification}
+#' }
+"scuba_cert"

R/scuba_clean.R

@@ -0,0 +1,39 @@
+#' Example of the logbook table
+#'
+#' A dataset containing an example of the logbook table, this table contains
+#' an example of what the column names must be and how the content must look like.
+#'
+#' @format A data frame with 500 rows and 30 variables:
+#' \describe{
+#'   \item{eventDate}{the date of the dive, in ISO8601}
+#'   \item{locationID}{the name of the dive site}
+#'   \item{maximumDepthInMeters}{the maximum depth of the dive, in meters}
+#'   \item{bottomTime}{the bottom time of the dive, in minutes}
+#'   \item{waterTemperature}{the average water temperature of the dive, in degrees celsius}
+#'   \item{visibility}{the visibility during the dive, categorical not standardized yet}
+#'   \item{extraWeight}{weight of the weight belt, in kilograms}
+#'   \item{diveType}{main type of dive, categorical}
+#'   \item{diveType_2}{secondary type of dive, not necessary}
+#'   \item{diveType_3}{terciary type of dive, not necessary}
+#'   \item{stop}{safety or emergency or no stop, not necessary}
+#'   \item{deepDive}{not necessary}
+#'   \item{nightDive}{not necessary}
+#'   \item{sidemountDive}{not necessary}
+#'   \item{boatDive}{not necessary}
+#'   \item{shoreDive}{not necessary}
+#'   \item{driftDive}{not necessary}
+#'   \item{caveDive}{not necessary}
+#'   \item{wreckDive}{not necessary}
+#'   \item{eventID}{identifier of each dive}
+#'   \item{rowid}{number of row}
+#'   \item{locality}{place where the dive site is located, village or town}
+#'   \item{region}{region where the dive site is located}
+#'   \item{country}{region where the dive site is located}
+#'   \item{decimalLatitude}{latitude of the dive site, in decimal degrees}   
+#'   \item{decimalLongitude}{longitude of the dive site, in decimal degrees}   
+#'   \item{platformType}{the type of dive regarding the entry platform, shore, boat or pool}   
+#'   \item{wreckType}{not necessary}
+#'   \item{caveType}{not necessary}
+#'   \item{diveClass}{main class of the dive, it groups several diveTypes into one diveClass, categorical}
+#' }
+"scuba_clean"

R/scuba_map.R

@@ -0,0 +1,40 @@
+#' Example of the logbook table in sf format
+#'
+#' A dataset containing an example of the logbook table in sf format, this table contains
+#' an example of what the column names must be and how the content must look like.
+#'
+#' @format A "simple feature" and data frame with 500 rows and 31 variables:
+#' \describe{
+#'   \item{eventDate}{the date of the dive, in ISO8601}
+#'   \item{locationID}{the name of the dive site}
+#'   \item{maximumDepthInMeters}{the maximum depth of the dive, in meters}
+#'   \item{bottomTime}{the bottom time of the dive, in minutes}
+#'   \item{waterTemperature}{the average water temperature of the dive, in degrees celsius}
+#'   \item{visibility}{the visibility during the dive, categorical not standardized yet}
+#'   \item{extraWeight}{weight of the weight belt, in kilograms}
+#'   \item{diveType}{main type of dive, categorical}
+#'   \item{diveType_2}{secondary type of dive, not necessary}
+#'   \item{diveType_3}{terciary type of dive, not necessary}
+#'   \item{stop}{safety or emergency or no stop, not necessary}
+#'   \item{deepDive}{not necessary}
+#'   \item{nightDive}{not necessary}
+#'   \item{sidemountDive}{not necessary}
+#'   \item{boatDive}{not necessary}
+#'   \item{shoreDive}{not necessary}
+#'   \item{driftDive}{not necessary}
+#'   \item{caveDive}{not necessary}
+#'   \item{wreckDive}{not necessary}
+#'   \item{eventID}{identifier of each dive}
+#'   \item{rowid}{number of row}
+#'   \item{locality}{place where the dive site is located, village or town}
+#'   \item{region}{region where the dive site is located}
+#'   \item{country}{region where the dive site is located}
+#'   \item{decimalLatitude}{latitude of the dive site, in decimal degrees}   
+#'   \item{decimalLongitude}{longitude of the dive site, in decimal degrees}   
+#'   \item{platformType}{the type of dive regarding the entry platform, shore, boat or pool}   
+#'   \item{wreckType}{not necessary}
+#'   \item{caveType}{not necessary}
+#'   \item{diveClass}{main class of the dive, it groups several diveTypes into one diveClass, categorical}
+#'   \item{geometry}{coordinates of the dive site in Points format}
+#' }
+"scuba_map"