writeAllTypeDays: Write the output data of a clustering in csv file

In rte-antares-rpackage/fbClust: A Tool Of Ptdf Manipulation In Order To Cluster And Visualize Domains

Write the output data of a clustering in csv file

Description

This function has been built to give the possibility to the user to keep the results of the clustering in a csv file using the output object of the functions clusterTypicalDaysForOneClass and clusteringTypicalDays. The user can choose to get the vertices of the input data, the raw ptdf of the input data or the ptdf after differenciation of the input data. One of the interests of this function is to get the ptdf to use easily the package fbAntares

Usage

writeAllTypeDays(allTypeDay, output = "ptdf", outputFile, csv = T,
  onlyTypicalDay = T)

Arguments

allTypeDay	data.table the output data.table of one of the functions clusterTypicalDaysForOneClass and clusteringTypicalDays. TypicalDay : The typical day of the cluster defined by the idDayType column. Class : The class of the clustering (typically, one of the classes obtained with the getCalendar function). dayIn : The details of the days in the cluster. distance : The distance of each day of the cluster to the typical day. idDayType : The id of the cluster.
output	character The type of output you want to return (either ptdf, ptdfraw, vertices), default ptdf ptdf : The ptdf obtained after differenciation ptdfraw : The raw ptdf (obtained just after getPreprocPlan) vertices : The vertices obtained with the function getVertices
outputFile	character The directory where you want to save the file.
csv	logical If you want to write a csv or a rds, default TRUE
onlyTypicalDay	logical If you want only the typical days or all days of the clustering

rte-antares-rpackage/fbClust documentation built on July 4, 2023, 12:06 a.m.