R/getTextParaDRAMUnlocked.R

In ShashankKumbhare/paramonteR: Plain Powerful Parallel Monte Carlo Library

####################################################################################################################################
################################## getTextParaDRAMUnlocked #########################################################################
# >>
getTextParaDRAMUnlocked <- function() {

    textParaDRAMUnlocked = "
ParaDRAMUnlocked <- R6::R6Class( 'ParaDRAM',

                            lock_objects = FALSE,

                            inherit = ParaMonteSampler,

                            # Private >> ###########################################################################################

                            private = list(

                                ParaDRAMUnlocked = NULL

                            ), # << Private

                            # Public >> ############################################################################################

                            public = list(

                                # initialize = function( platform = pm$platform,
                                #                        website  = pm$website ) {

                                initialize = function( platform = '',
                                                       website  = '' ) {

                                    super$initialize(platform, website)                                  # >> ParaMonteSampler class

                                    private$method$isParaDRAM = TRUE
                                    private$Err$prefix        = private$methodName

                                },

                                print = function() {

                                    tab             = private$Err$tab

                                    private$Err$box = paste( 'Post-Processing Usage:', '\n',
                                                             '\n',
                                                             tab, 'Call ParaDRAM routines as:', '\n',
                                                             '\n',
                                                             tab, tab, 'To read Chain file:    pmpd$readChain(\"filename\")   ', '\n',
                                                             tab, tab, 'To read Sample file:   pmpd$readSample(\"filename\")  ', '\n',
                                                             tab, tab, 'To read Report file:   pmpd$readReport(\"filename\")  ', '\n',
                                                             tab, tab, 'To read Restart file:  pmpd$readRestart(\"filename\") ', '\n',
                                                             tab, tab, 'To read Progress file: pmpd$readProgress(\"filename\")', '\n',
                                                             sep = '' )

                                }

                            ) # << Public

)
# <<
################################## ParaDRAMUnlocked ################################################################################
####################################################################################################################################
"

    return( textParaDRAMUnlocked )

}
# <<
################################## getTextParaDRAMUnlocked #########################################################################
####################################################################################################################################


####################################################################################################################################
################################## Help Code #######################################################################################
# >>
# getTextParaDRAMUnlocked()
# <<
################################## Help Code #######################################################################################
####################################################################################################################################