annotate MassdbConn.R @ 1:253d531a0193 draft

planemo upload for repository https://github.com/workflow4metabolomics/lcmsmatching.git commit 36c9d8099c20a1ae848f1337c16564335dd8fb2b

if ( ! exists('MassdbConn')) {

	source('BiodbConn.R')

	#####################
	# CLASS DECLARATION #
	#####################
	
	MassdbConn <- setRefClass("MassdbConn", contains = "BiodbConn")

	###############################
	# GET CHROMATOGRAPHIC COLUMNS #
	###############################
	
	# Get a list of chromatographic columns contained in this database.
	# compound.ids  A list of compound IDs used to filter results.
	# The returned value is a data.frame with two columns : one for the ID (BIODB.ID) and another one for the title (BIODB.TITLE).
	MassdbConn$methods( getChromCol = function(compound.ids = NULL) {
		stop("Method getChromCol() is not implemented in concrete class.")
	})

	#################
	# GET MZ VALUES #
	#################
	
	# Returns a numeric vector of all masses stored inside the database.
	MassdbConn$methods( getMzValues = function(mode = NULL, max.results = NA_integer_) {
		stop("Method getMzValues() not implemented in concrete class.")
	})

}