Module saePisan.model.SaeEblupUnit

Classes

class SaeEblupUnit (*args, **kwargs)
Expand source code
class SaeEblupUnit(SaeModelling):
    """
    SaeEblupUnit is a class that extends SaeModelling to run EBLUP (Empirical Best Linear Unbiased Prediction) models.
    Methods
    -------
    __init__(*args, **kwargs)
        Initializes the SaeEblupUnit instance with given arguments.
    run_model(r_script)
        Runs the EBLUP model using the provided R script.
        Parameters
        ----------
        r_script : str
            The R script to be executed for running the EBLUP model.
        Returns
        -------
        result : Any
            The result of the EBLUP model execution.
        error : Any
            Any error encountered during the model execution.
        df : pandas.DataFrame
            The dataframe containing the results of the model execution.
    get_model2()
        Returns the model2 attribute.
        Returns
        -------
        model2 : Any
            The model2 attribute of the instance.
    """
    
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
    
    def run_model(self, r_script):
        self.r_script = r_script
        results, error, df = run_model_eblup_unit(self)
        return results, error, df
    
    def get_model2(self):
        return self.model2

SaeEblupUnit is a class that extends SaeModelling to run EBLUP (Empirical Best Linear Unbiased Prediction) models. Methods


init(args, *kwargs) Initializes the SaeEblupUnit instance with given arguments. run_model(r_script) Runs the EBLUP model using the provided R script. Parameters ---------- r_script : str The R script to be executed for running the EBLUP model. Returns ------- result : Any The result of the EBLUP model execution. error : Any Any error encountered during the model execution. df : pandas.DataFrame The dataframe containing the results of the model execution. get_model2() Returns the model2 attribute. Returns ------- model2 : Any The model2 attribute of the instance.

Ancestors

  • model.SaeModelling.SaeModelling

Methods

def get_model2(self)
Expand source code
def get_model2(self):
    return self.model2
def run_model(self, r_script)
Expand source code
def run_model(self, r_script):
    self.r_script = r_script
    results, error, df = run_model_eblup_unit(self)
    return results, error, df