R/toXML2_features.R

In IFC: Tools for Imaging Flow Cytometry

################################################################################
# This file is released under the GNU General Public License, Version 3, GPL-3 #
# Copyright (C) 2020 Yohann Demont                                             #
#                                                                              #
# It is part of IFC package, please cite:                                      #
# -IFC: An R Package for Imaging Flow Cytometry                                #
# -YEAR: 2020                                                                  #
# -COPYRIGHT HOLDERS: Yohann Demont, Gautier Stoll, Guido Kroemer,             #
#                     Jean-Pierre Marolleau, Loïc Garçon,                      #
#                     INSERM, UPD, CHU Amiens                                  #
#                                                                              #
# DISCLAIMER:                                                                  #
# -You are using this package on your own risk!                                #
# -We do not guarantee privacy nor confidentiality.                            #
# -This program is distributed in the hope that it will be useful, but WITHOUT #
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        #
# FITNESS FOR A PARTICULAR PURPOSE. In no event shall the copyright holders or #
# contributors be liable for any direct, indirect, incidental, special,        #
# exemplary, or consequential damages (including, but not limited to,          #
# procurement of substitute goods or services; loss of use, data, or profits;  #
# or business interruption) however caused and on any theory of liability,     #
# whether in contract, strict liability, or tort (including negligence or      #
# otherwise) arising in any way out of the use of this software, even if       #
# advised of the possibility of such damage.                                   #
#                                                                              #
# You should have received a copy of the GNU General Public License            #
# along with IFC. If not, see <http://www.gnu.org/licenses/>.                  #
################################################################################

#' @title IFC_features XML Conversion
#' @description 
#' Helper to convert features (`IFC_features` object) to XML nodes.
#' @param features an `IFC_features` object.
#' @param verbose whether to display message about current action. Default is \code{FALSE}.
#' @param display_progress whether to display a progress bar. Default is \code{TRUE}.
#' @param title_progress character string, giving the title of the progress bar. Default is \code{""}.
#' @return a xml_node.
#' @keywords internal
toXML2_features = function(features, verbose = FALSE, display_progress = TRUE, title_progress = "") {
  assert(verbose, alw = c(TRUE, FALSE))
  if(verbose) message("creating features node")
  assert(features, cla = "IFC_features")
  if(length(features)==0) return(xml_new_node(name = "FeatureValues", text = ""))
  xml_new_node(name = "FeatureValues", .children = lapply(1:length(features), FUN=function(i) {
    xml_new_node(name = "UDFValues", attrs = list("fid" = i-1, "fv" = paste0(features[[i]], collapse = "|")))
  }))
}