R/activity.R

#' @name activity
#' @title R6 class activity
#' @description Create R6 reference object class activity
#' @importFrom R6 R6Class
#' @importFrom lubridate ymd
activity <- R6::R6Class(classname = "activity",
                        public = list(
                          # initialize ----
                          #' @description Initialize function for R6 activities class.
                          #' @param trip_id Object of class {\link[base]{character}} expected. Trip identification.
                          #' @param activity_id Object of class {\link[base]{character}} expected. Activity identification.
                          #' @param ocean Object of class {\link[base]{integer}} expected. Ocean identification.
                          #' @param activity_date Object of class {\link[base]{character}} expected. Activity date in format year month day.
                          #' @param activity_number Object of class {\link[base]{integer}} expected. Activity number.
                          #' @param activity_latitude Object of class {\link[base]{numeric}} expected. Latitude, in decimal degree, of the activity.
                          #' @param activity_longitude Object of class {\link[base]{numeric}} expected. Longitude, in decimal degree, of the activity.
                          #' @param set_count Object of class {\link[base]{integer}} expected. Number of set associated to the activity.
                          #' @param school_type Object of class {\link[base]{integer}} expected. School type identification.
                          #' @param activity_code Object of class {\link[base]{integer}} expected. Activity code identification.
                          #' @param activity_name Object of class {\link[base]{character}} expected. Activity identification.
                          #' @param time_at_sea Object of class {\link[base]{integer}} expected. Time at sea in hours.
                          initialize = function(trip_id,
                                                activity_id,
                                                ocean,
                                                activity_date,
                                                activity_number,
                                                activity_latitude,
                                                activity_longitude,
                                                set_count,
                                                school_type,
                                                activity_code,
                                                activity_name,
                                                time_at_sea) {
                            # attribute "trip_id" verification
                            check_trip_id(trip_id)
                            # attribute "activity_id" verification
                            check_activity_id(activity_id)
                            # attribute "ocean" verification
                            check_ocean(ocean)
                            # attribute "activity_date" verification
                            check_activity_date(activity_date = activity_date)
                            # attribute "check_activity_number" verification
                            check_activity_number(activity_number)
                            # attribute "check_activity_latitude" verification
                            check_activity_latitude(activity_latitude)
                            # attribute "check_activity_longitude" verification
                            check_activity_longitude(activity_longitude)
                            # attribute "set_count" verification
                            check_set_count(set_count)
                            # attribute "school_type" verification
                            check_school_type(school_type)
                            # attribute "activity_code" verification
                            check_activity_code(activity_code)
                            # attribute "school_type" verification
                            check_activity_name(activity_name)
                            # attribute "time_at_sea" verification
                            check_time_at_sea(time_at_sea)
                            # attributeions
                            private$trip_id <- trip_id
                            private$activity_id <- activity_id
                            private$ocean <- ocean
                            private$activity_date <- lubridate::ymd(activity_date,
                                                                    quiet = TRUE)
                            private$activity_number <- activity_number
                            private$activity_longitude <- activity_longitude
                            private$activity_latitude <- activity_latitude
                            private$set_count <- set_count
                            private$school_type <- school_type
                            private$activity_code <- activity_code
                            private$activity_name <- activity_name
                            private$time_at_sea <- time_at_sea}),
                        private = list(
                          trip_id = NULL,
                          activity_id = NULL,
                          ocean = NULL,
                          activity_date = NULL,
                          activity_number = NULL,
                          activity_latitude = NULL,
                          activity_longitude = NULL,
                          set_count = NULL,
                          school_type = NULL,
                          activity_code = NULL,
                          activity_name = NULL,
                          time_at_sea = NULL,
                          positive_set_count = NULL,
                          set_duration = NULL,
                          elementarycatches = NULL))
OB7-IRD/t3 documentation built on May 11, 2024, 7:02 a.m.