R/elementarysample.R

#' @name elementarysample
#' @title R6 class trip
#' @description Create R6 reference object class elementarysample
#' @importFrom R6 R6Class
elementarysample <- R6::R6Class(classname = "elementarysample",
                                  public = list(
                                    # initialize ----
                                    #' @description Initialize function for R6 elementarysample class.
                                    #' @param trip_id Object of class {\link[base]{character}} expected. Trip identification.
                                    #' @param well_id Object of class {\link[base]{character}} expected. Well identification.
                                    #' @param sample_id Object of class {\link[base]{character}} expected. Sample identification.
                                    #' @param sub_sample_id Object of class {\link[base]{integer}} expected. Sub sample identification.
                                    #' @param sample_quality Object of class {\link[base]{integer}} expected. Sample quality identification.
                                    #' @param sample_type Object of class {\link[base]{integer}} expected. Sample type identification.
                                    #' @param specie_code Object of class {\link[base]{integer}} expected. Specie code identification.
                                    #' @param specie_code3l Object of class {\link[base]{character}} expected. Specie code identification on 3 characters.
                                    #' @param sample_standardised_length_class_lf Object of class {\link[base]{integer}} expected. Sample standardised length class length fork of measured individus.
                                    #' @param sample_number_measured_extrapolated_lf Object of class {\link[base]{numeric}} expected. Sample number of measured individus extrapolated to all counted individus.
                                    #' @param sample_total_count Object of class {\link[base]{integer}} expected. Sample number of total individus counted.
                                    initialize = function(trip_id,
                                                          well_id,
                                                          sample_id,
                                                          sub_sample_id,
                                                          sample_quality,
                                                          sample_type,
                                                          specie_code,
                                                          specie_code3l,
                                                          sample_standardised_length_class_lf,
                                                          sample_number_measured_extrapolated_lf,
                                                          sample_total_count) {
                                      # attribute "trip_id" verification
                                      check_trip_id(trip_id)
                                      # attribute "well_id" verification
                                      check_well_id(well_id)
                                      # attribute "sample_id" verification
                                      check_sample_id(sample_id)
                                      # attribute "sub_sample_id" verification
                                      check_sub_sample_id(sub_sample_id)
                                      # attribute "sample_quality" verification
                                      check_sample_quality(sample_quality)
                                      # attribute "sample_type" verification
                                      check_sample_type(sample_type)
                                      # attribute "specie_code" verification
                                      check_specie_code(specie_code)
                                      # attribute "specie_code3l" verification
                                      check_specie_code3l(specie_code3l)
                                      # attribute "sample_standardised_length_class_lf" verification
                                      check_sample_standardised_length_class_lf(sample_standardised_length_class_lf)
                                      # attribute "sample_number_measured_extrapolated_lf" verification
                                      check_sample_number_measured_extrapolated_lf(sample_number_measured_extrapolated_lf)
                                      # attribute "sample_total_count" verification
                                      check_sample_total_count(sample_total_count)
                                      # attributions
                                      private$trip_id <- trip_id
                                      private$well_id <- well_id
                                      private$sample_id <- sample_id
                                      private$sub_sample_id <- sub_sample_id
                                      private$sample_quality <- sample_quality
                                      private$sample_type <- sample_type
                                      private$specie_code <- specie_code
                                      private$specie_code3l <- specie_code3l
                                      private$sample_standardised_length_class_lf <- sample_standardised_length_class_lf
                                      private$sample_number_measured_extrapolated_lf <- sample_number_measured_extrapolated_lf
                                      private$sample_total_count <- sample_total_count
                                    }),
                                  private = list(
                                    trip_id = NULL,
                                    well_id = NULL,
                                    sample_id = NULL,
                                    sub_sample_id = NULL,
                                    sample_quality = NULL,
                                    sample_type = NULL,
                                    specie_code = NULL,
                                    specie_code3l = NULL,
                                    sample_standardised_length_class_lf = NULL,
                                    sample_number_measured_extrapolated_lf = NULL,
                                    sample_total_count = NULL))
OB7-IRD/t3 documentation built on May 11, 2024, 7:02 a.m.