R/Actif-load.R

##' Fonction \code{load_actif}.
##'
##' Cette fonction permet de charger les donnees pour un objet de type \code{\link{Actif}}. Les donnees auront ete prealablement disposees dans
##' une architecture propre a \code{SiALM}.
##'
##' La creation d'un objet \code{\link{Actif}} necessite la creation de deux autres objets : \code{\link{PTFActif}}, \code{\link{HypActif}}.
##'
##' @name load_actif
##' @docType methods
##' @param address est un objet de type \code{character} indiquant le dossier dans lequel se situe l'ensemble des donnees necessaires
##' pour la construction de l'objet.
##' @author Damien Tichit pour Sia Partners
##' @seealso Construction d'un objet de type \code{\link{PTFActif}} : \code{\link{load_ptf_actif}}.
##' @seealso Construction d'un objet de type \code{\link{HypActif}} : \code{\link{load_hyp_actif}}.
##' @export
##' @include HypActif-class.R HypActif-load.R PTFActif-class.R PTFActif-load.R Actif-class.R
##'
setGeneric(name = "load_actif", def = function(address) {standardGeneric("load_actif")})
setMethod(
    f = "load_actif",
    signature = c(address = "character"),
    definition = function(address){

        # Creation des attributs
        ptf_actif      <- load_ptf_actif(paste(address, "01_Portefeuilles", sep = "/"))
        hyp_actif      <- load_hyp_actif(paste(address, "02_Hypotheses", sep = "/"))

        # Creation de l'objet
        actif <- new("Actif", ptf_actif = ptf_actif, hyp_actif = hyp_actif)

        # Output
        return(actif)
    }
)
DTichit/ALModel documentation built on Feb. 11, 2021, 12:32 a.m.