This document describes a typical use of the antaresRead package.
-
This package has been designed to read the results of an Antares simulation in an easy and convivial way. It can of course read any output files of a simulation at any desired time step, read synthetic results or detailed Monte Carlo scenarios but it can also add input time series to the results and perform some basic treatments like removing virtual areas.
-
-
-Installation
-
The antaresRead package depends on the packages data.table, plyr and lubridate. If you have not already got them you can install them with the following command:
Then you can start using the package. The first function to use is setSimulationPath.
-
This function needs to be called at least once during each R session. It stores important informations that are used by most of the functions of the package. While it has not been run, these functions will not work.
-
Without any argument, setSimulationPath asks interactively to choose a directory containing an antares study. If the study contains multiple simulation results, it will also asks the user to choose one of them. This function stores the path to the output and reads some useful information about the simulation: type of output available, list of areas, links and clusters in the simulation, variables present in the output files, etc.
-
setSimulationPath can also be used in a non-interactive way with one of these syntaxes:
The function returns an object containing informations about the selected simulation. You can store this object in a variable for later use but this is not necessary because at any moment you can retrieve these informations.
-
-
-
-Reading time series
-
Once setSimulationPath has been run, you can start reading data. Function readAntares is there for that !
-
readAntares is the main function of the package. It is used to read every possible time series and it performs a few treatments on them to make your life easier. The result of the function will have the simplest structure possible: either a simple table or a list of tables if you asks data for differents elements (for instance links and areas)
-
It has a huge number of parameters to control exactly what you get, but all of them are optional. Without any argument the function will still works and it will read the synthetic results for all the areas. But you can import other kind of output. here are some examples:
You can also choose what elements to import and what level of details you want. For instance, the following command reads the first 10 Monte-Carlo scenarii data at monthly time step for the areas named “area1”, “area2” and “area3”.
Finally many arguments of readAntares can be used to add input time series to the object returned by the function. For instance, misc=TRUE will add columns containing miscelaneous productions for the imported areas.
-
-
-
-Manipulating data
-
readAntares returns either a single table or a list of tables depending on the query of the user. More precisely the tables are data.table objects. It is then possible to use the powerful syntax offered by the package data.table.
For instance, areas[area == "08_fr", .(timeId, LOAD)] will return a table containing columns timeId and LOAD for the area names “08_fr”. In the select statement, it is also possible to calculate new columns. For instance, one can compute the net load like this:
readAntares can import almost everything but not everything because some data is not time series. Other functions exist to read this specific data: readBindingConstraints to read binding constraints, readClusterDesc to read cluster characteristics and readLayout to get the coordinates of the areas in the user interface of Antares.
-
Some parameters in readAntares and other functions wait for vectors of area names or link names. On large projects with lots of areas. It may be painful to specify by hand a long list of areas or links. Hopefully, the functions getAreasand getLinks can be used to select or exclude areas using regular expressions. For instance, let us assume that the name of all areas located in France start with the characters“fr”, then the following command returns the list of all french areas:
With h5 file, antaresRead will be running faster. Your reading will take between 2 and 4 times less time. An other avantage is the compression, a study can pass from 15Go in txt to 2.5Go in h5. Furthermore, a h5 transformation convert lot of txt file in a single h5 file, it will be easier to move it, a copy/paste of a study with 137 thousand files (15Go) takes 45 minutes in txt and 30 seconds in h5.
-
Finally, you can use in the same way function of antaresProcessing and antaresViz packages. You can also use addProcessingH5 function to add columns to your h5 file.
-
-
-
Comparaison between Conventional and H5
-
-
-
-
-
Write h5 file from antares study
-
-
The function writeAntaresH5 is used to write h5 file from antares output. You can add inputs data like in readAntares.
").addClass(b),h("td",c).addClass(b).html(a)[0].colSpan=V(d),e.push(c[0]))};f(a,b);c._details&&c._details.detach();c._details=h(e);
-c._detailsShow&&c._details.insertAfter(c.nTr)}return this});o(["row().child.show()","row().child().show()"],function(){Ub(this,!0);return this});o(["row().child.hide()","row().child().hide()"],function(){Ub(this,!1);return this});o(["row().child.remove()","row().child().remove()"],function(){db(this);return this});o("row().child.isShown()",function(){var a=this.context;return a.length&&this.length?a[0].aoData[this[0]]._detailsShow||!1:!1});var bc=/^([^:]+):(name|visIdx|visible)$/,Vb=function(a,b,
-c,d,e){for(var c=[],d=0,f=e.length;d=0?b:g.length+b];if(typeof a==="function"){var e=Ba(c,f);return h.map(g,function(b,f){return a(f,Vb(c,f,0,0,e),i[f])?f:null})}var k=typeof a==="string"?a.match(bc):
-"";if(k)switch(k[2]){case "visIdx":case "visible":b=parseInt(k[1],10);if(b<0){var n=h.map(g,function(a,b){return a.bVisible?b:null});return[n[n.length+b]]}return[aa(c,b)];case "name":return h.map(j,function(a,b){return a===k[1]?b:null});default:return[]}if(a.nodeName&&a._DT_CellIndex)return[a._DT_CellIndex.column];b=h(i).filter(a).map(function(){return h.inArray(this,i)}).toArray();if(b.length||!a.nodeName)return b;b=h(a).closest("*[data-dt-column]");return b.length?[b.data("dt-column")]:[]},c,f)},
-1);c.selector.cols=a;c.selector.opts=b;return c});u("columns().header()","column().header()",function(){return this.iterator("column",function(a,b){return a.aoColumns[b].nTh},1)});u("columns().footer()","column().footer()",function(){return this.iterator("column",function(a,b){return a.aoColumns[b].nTf},1)});u("columns().data()","column().data()",function(){return this.iterator("column-rows",Vb,1)});u("columns().dataSrc()","column().dataSrc()",function(){return this.iterator("column",function(a,b){return a.aoColumns[b].mData},
-1)});u("columns().cache()","column().cache()",function(a){return this.iterator("column-rows",function(b,c,d,e,f){return ja(b.aoData,f,"search"===a?"_aFilterData":"_aSortData",c)},1)});u("columns().nodes()","column().nodes()",function(){return this.iterator("column-rows",function(a,b,c,d,e){return ja(a.aoData,e,"anCells",b)},1)});u("columns().visible()","column().visible()",function(a,b){var c=this.iterator("column",function(b,c){if(a===k)return b.aoColumns[c].bVisible;var f=b.aoColumns,g=f[c],j=b.aoData,
-i,m,l;if(a!==k&&g.bVisible!==a){if(a){var n=h.inArray(!0,D(f,"bVisible"),c+1);i=0;for(m=j.length;id;return!0};n.isDataTable=
-n.fnIsDataTable=function(a){var b=h(a).get(0),c=!1;if(a instanceof n.Api)return!0;h.each(n.settings,function(a,e){var f=e.nScrollHead?h("table",e.nScrollHead)[0]:null,g=e.nScrollFoot?h("table",e.nScrollFoot)[0]:null;if(e.nTable===b||f===b||g===b)c=!0});return c};n.tables=n.fnTables=function(a){var b=!1;h.isPlainObject(a)&&(b=a.api,a=a.visible);var c=h.map(n.settings,function(b){if(!a||a&&h(b.nTable).is(":visible"))return b.nTable});return b?new s(c):c};n.camelToHungarian=J;o("$()",function(a,b){var c=
-this.rows(b).nodes(),c=h(c);return h([].concat(c.filter(a).toArray(),c.find(a).toArray()))});h.each(["on","one","off"],function(a,b){o(b+"()",function(){var a=Array.prototype.slice.call(arguments);a[0]=h.map(a[0].split(/\s/),function(a){return!a.match(/\.dt\b/)?a+".dt":a}).join(" ");var d=h(this.tables().nodes());d[b].apply(d,a);return this})});o("clear()",function(){return this.iterator("table",function(a){oa(a)})});o("settings()",function(){return new s(this.context,this.context)});o("init()",function(){var a=
-this.context;return a.length?a[0].oInit:null});o("data()",function(){return this.iterator("table",function(a){return D(a.aoData,"_aData")}).flatten()});o("destroy()",function(a){a=a||!1;return this.iterator("table",function(b){var c=b.nTableWrapper.parentNode,d=b.oClasses,e=b.nTable,f=b.nTBody,g=b.nTHead,j=b.nTFoot,i=h(e),f=h(f),k=h(b.nTableWrapper),l=h.map(b.aoData,function(a){return a.nTr}),o;b.bDestroying=!0;r(b,"aoDestroyCallback","destroy",[b]);a||(new s(b)).columns().visible(!0);k.off(".DT").find(":not(tbody *)").off(".DT");
-h(E).off(".DT-"+b.sInstance);e!=g.parentNode&&(i.children("thead").detach(),i.append(g));j&&e!=j.parentNode&&(i.children("tfoot").detach(),i.append(j));b.aaSorting=[];b.aaSortingFixed=[];wa(b);h(l).removeClass(b.asStripeClasses.join(" "));h("th, td",g).removeClass(d.sSortable+" "+d.sSortableAsc+" "+d.sSortableDesc+" "+d.sSortableNone);f.children().detach();f.append(l);g=a?"remove":"detach";i[g]();k[g]();!a&&c&&(c.insertBefore(e,b.nTableReinsertBefore),i.css("width",b.sDestroyWidth).removeClass(d.sTable),
-(o=b.asDestroyStripes.length)&&f.children().each(function(a){h(this).addClass(b.asDestroyStripes[a%o])}));c=h.inArray(b,n.settings);-1!==c&&n.settings.splice(c,1)})});h.each(["column","row","cell"],function(a,b){o(b+"s().every()",function(a){var d=this.selector.opts,e=this;return this.iterator(b,function(f,g,h,i,m){a.call(e[b](g,"cell"===b?h:d,"cell"===b?d:k),g,h,i,m)})})});o("i18n()",function(a,b,c){var d=this.context[0],a=S(a)(d.oLanguage);a===k&&(a=b);c!==k&&h.isPlainObject(a)&&(a=a[c]!==k?a[c]:
-a._);return a.replace("%d",c)});n.version="1.10.19";n.settings=[];n.models={};n.models.oSearch={bCaseInsensitive:!0,sSearch:"",bRegex:!1,bSmart:!0};n.models.oRow={nTr:null,anCells:null,_aData:[],_aSortData:null,_aFilterData:null,_sFilterRow:null,_sRowStripe:"",src:null,idx:-1};n.models.oColumn={idx:null,aDataSort:null,asSorting:null,bSearchable:null,bSortable:null,bVisible:null,_sManualType:null,_bAttrSrc:!1,fnCreatedCell:null,fnGetData:null,fnSetData:null,mData:null,mRender:null,nTh:null,nTf:null,
-sClass:null,sContentPadding:null,sDefaultContent:null,sName:null,sSortDataType:"std",sSortingClass:null,sSortingClassJUI:null,sTitle:null,sType:null,sWidth:null,sWidthOrig:null};n.defaults={aaData:null,aaSorting:[[0,"asc"]],aaSortingFixed:[],ajax:null,aLengthMenu:[10,25,50,100],aoColumns:null,aoColumnDefs:null,aoSearchCols:[],asStripeClasses:null,bAutoWidth:!0,bDeferRender:!1,bDestroy:!1,bFilter:!0,bInfo:!0,bLengthChange:!0,bPaginate:!0,bProcessing:!1,bRetrieve:!1,bScrollCollapse:!1,bServerSide:!1,
-bSort:!0,bSortMulti:!0,bSortCellsTop:!1,bSortClasses:!0,bStateSave:!1,fnCreatedRow:null,fnDrawCallback:null,fnFooterCallback:null,fnFormatNumber:function(a){return a.toString().replace(/\B(?=(\d{3})+(?!\d))/g,this.oLanguage.sThousands)},fnHeaderCallback:null,fnInfoCallback:null,fnInitComplete:null,fnPreDrawCallback:null,fnRowCallback:null,fnServerData:null,fnServerParams:null,fnStateLoadCallback:function(a){try{return JSON.parse((-1===a.iStateDuration?sessionStorage:localStorage).getItem("DataTables_"+
-a.sInstance+"_"+location.pathname))}catch(b){}},fnStateLoadParams:null,fnStateLoaded:null,fnStateSaveCallback:function(a,b){try{(-1===a.iStateDuration?sessionStorage:localStorage).setItem("DataTables_"+a.sInstance+"_"+location.pathname,JSON.stringify(b))}catch(c){}},fnStateSaveParams:null,iStateDuration:7200,iDeferLoading:null,iDisplayLength:10,iDisplayStart:0,iTabIndex:0,oClasses:{},oLanguage:{oAria:{sSortAscending:": activate to sort column ascending",sSortDescending:": activate to sort column descending"},
-oPaginate:{sFirst:"First",sLast:"Last",sNext:"Next",sPrevious:"Previous"},sEmptyTable:"No data available in table",sInfo:"Showing _START_ to _END_ of _TOTAL_ entries",sInfoEmpty:"Showing 0 to 0 of 0 entries",sInfoFiltered:"(filtered from _MAX_ total entries)",sInfoPostFix:"",sDecimal:"",sThousands:",",sLengthMenu:"Show _MENU_ entries",sLoadingRecords:"Loading...",sProcessing:"Processing...",sSearch:"Search:",sSearchPlaceholder:"",sUrl:"",sZeroRecords:"No matching records found"},oSearch:h.extend({},
-n.models.oSearch),sAjaxDataProp:"data",sAjaxSource:null,sDom:"lfrtip",searchDelay:null,sPaginationType:"simple_numbers",sScrollX:"",sScrollXInner:"",sScrollY:"",sServerMethod:"GET",renderer:null,rowId:"DT_RowId"};Z(n.defaults);n.defaults.column={aDataSort:null,iDataSort:-1,asSorting:["asc","desc"],bSearchable:!0,bSortable:!0,bVisible:!0,fnCreatedCell:null,mData:null,mRender:null,sCellType:"td",sClass:"",sContentPadding:"",sDefaultContent:null,sName:"",sSortDataType:"std",sTitle:null,sType:null,sWidth:null};
-Z(n.defaults.column);n.models.oSettings={oFeatures:{bAutoWidth:null,bDeferRender:null,bFilter:null,bInfo:null,bLengthChange:null,bPaginate:null,bProcessing:null,bServerSide:null,bSort:null,bSortMulti:null,bSortClasses:null,bStateSave:null},oScroll:{bCollapse:null,iBarWidth:0,sX:null,sXInner:null,sY:null},oLanguage:{fnInfoCallback:null},oBrowser:{bScrollOversize:!1,bScrollbarLeft:!1,bBounding:!1,barWidth:0},ajax:null,aanFeatures:[],aoData:[],aiDisplay:[],aiDisplayMaster:[],aIds:{},aoColumns:[],aoHeader:[],
-aoFooter:[],oPreviousSearch:{},aoPreSearchCols:[],aaSorting:null,aaSortingFixed:[],asStripeClasses:null,asDestroyStripes:[],sDestroyWidth:0,aoRowCallback:[],aoHeaderCallback:[],aoFooterCallback:[],aoDrawCallback:[],aoRowCreatedCallback:[],aoPreDrawCallback:[],aoInitComplete:[],aoStateSaveParams:[],aoStateLoadParams:[],aoStateLoaded:[],sTableId:"",nTable:null,nTHead:null,nTFoot:null,nTBody:null,nTableWrapper:null,bDeferLoading:!1,bInitialised:!1,aoOpenRows:[],sDom:null,searchDelay:null,sPaginationType:"two_button",
-iStateDuration:0,aoStateSave:[],aoStateLoad:[],oSavedState:null,oLoadedState:null,sAjaxSource:null,sAjaxDataProp:null,bAjaxDataGet:!0,jqXHR:null,json:k,oAjaxData:k,fnServerData:null,aoServerParams:[],sServerMethod:null,fnFormatNumber:null,aLengthMenu:null,iDraw:0,bDrawing:!1,iDrawError:-1,_iDisplayLength:10,_iDisplayStart:0,_iRecordsTotal:0,_iRecordsDisplay:0,oClasses:{},bFiltered:!1,bSorted:!1,bSortCellsTop:null,oInit:null,aoDestroyCallback:[],fnRecordsTotal:function(){return"ssp"==y(this)?1*this._iRecordsTotal:
-this.aiDisplayMaster.length},fnRecordsDisplay:function(){return"ssp"==y(this)?1*this._iRecordsDisplay:this.aiDisplay.length},fnDisplayEnd:function(){var a=this._iDisplayLength,b=this._iDisplayStart,c=b+a,d=this.aiDisplay.length,e=this.oFeatures,f=e.bPaginate;return e.bServerSide?!1===f||-1===a?b+d:Math.min(b+a,this._iRecordsDisplay):!f||c>d||-1===a?d:c},oInstance:null,sInstance:null,iTabIndex:0,nScrollHead:null,nScrollFoot:null,aLastSort:[],oPlugins:{},rowIdFn:null,rowId:null};n.ext=x={buttons:{},
-classes:{},builder:"-source-",errMode:"alert",feature:[],search:[],selector:{cell:[],column:[],row:[]},internal:{},legacy:{ajax:null},pager:{},renderer:{pageButton:{},header:{}},order:{},type:{detect:[],search:{},order:{}},_unique:0,fnVersionCheck:n.fnVersionCheck,iApiIndex:0,oJUIClasses:{},sVersion:n.version};h.extend(x,{afnFiltering:x.search,aTypes:x.type.detect,ofnSearch:x.type.search,oSort:x.type.order,afnSortData:x.order,aoFeatures:x.feature,oApi:x.internal,oStdClasses:x.classes,oPagination:x.pager});
-h.extend(n.ext.classes,{sTable:"dataTable",sNoFooter:"no-footer",sPageButton:"paginate_button",sPageButtonActive:"current",sPageButtonDisabled:"disabled",sStripeOdd:"odd",sStripeEven:"even",sRowEmpty:"dataTables_empty",sWrapper:"dataTables_wrapper",sFilter:"dataTables_filter",sInfo:"dataTables_info",sPaging:"dataTables_paginate paging_",sLength:"dataTables_length",sProcessing:"dataTables_processing",sSortAsc:"sorting_asc",sSortDesc:"sorting_desc",sSortable:"sorting",sSortableAsc:"sorting_asc_disabled",
-sSortableDesc:"sorting_desc_disabled",sSortableNone:"sorting_disabled",sSortColumn:"sorting_",sFilterInput:"",sLengthSelect:"",sScrollWrapper:"dataTables_scroll",sScrollHead:"dataTables_scrollHead",sScrollHeadInner:"dataTables_scrollHeadInner",sScrollBody:"dataTables_scrollBody",sScrollFoot:"dataTables_scrollFoot",sScrollFootInner:"dataTables_scrollFootInner",sHeaderTH:"",sFooterTH:"",sSortJUIAsc:"",sSortJUIDesc:"",sSortJUI:"",sSortJUIAscAllowed:"",sSortJUIDescAllowed:"",sSortJUIWrapper:"",sSortIcon:"",
-sJUIHeader:"",sJUIFooter:""});var Lb=n.ext.pager;h.extend(Lb,{simple:function(){return["previous","next"]},full:function(){return["first","previous","next","last"]},numbers:function(a,b){return[ia(a,b)]},simple_numbers:function(a,b){return["previous",ia(a,b),"next"]},full_numbers:function(a,b){return["first","previous",ia(a,b),"next","last"]},first_last_numbers:function(a,b){return["first",ia(a,b),"last"]},_numbers:ia,numbers_length:7});h.extend(!0,n.ext.renderer,{pageButton:{_:function(a,b,c,d,e,
-f){var g=a.oClasses,j=a.oLanguage.oPaginate,i=a.oLanguage.oAria.paginate||{},m,l,n=0,o=function(b,d){var k,s,u,r,v=function(b){Ta(a,b.data.action,true)};k=0;for(s=d.length;k").appendTo(b);o(u,r)}else{m=null;l="";switch(r){case "ellipsis":b.append('…');break;case "first":m=j.sFirst;l=r+(e>0?"":" "+g.sPageButtonDisabled);break;case "previous":m=j.sPrevious;l=r+(e>0?"":" "+g.sPageButtonDisabled);break;case "next":m=
-j.sNext;l=r+(e",{"class":g.sPageButton+" "+l,"aria-controls":a.sTableId,"aria-label":i[r],"data-dt-idx":n,tabindex:a.iTabIndex,id:c===0&&typeof r==="string"?a.sTableId+"_"+r:null}).html(m).appendTo(b);Wa(u,{action:r},v);n++}}}},s;try{s=h(b).find(H.activeElement).data("dt-idx")}catch(u){}o(h(b).empty(),d);s!==k&&h(b).find("[data-dt-idx="+
-s+"]").focus()}}});h.extend(n.ext.type.detect,[function(a,b){var c=b.oLanguage.sDecimal;return $a(a,c)?"num"+c:null},function(a){if(a&&!(a instanceof Date)&&!Zb.test(a))return null;var b=Date.parse(a);return null!==b&&!isNaN(b)||M(a)?"date":null},function(a,b){var c=b.oLanguage.sDecimal;return $a(a,c,!0)?"num-fmt"+c:null},function(a,b){var c=b.oLanguage.sDecimal;return Qb(a,c)?"html-num"+c:null},function(a,b){var c=b.oLanguage.sDecimal;return Qb(a,c,!0)?"html-num-fmt"+c:null},function(a){return M(a)||
-"string"===typeof a&&-1!==a.indexOf("<")?"html":null}]);h.extend(n.ext.type.search,{html:function(a){return M(a)?a:"string"===typeof a?a.replace(Nb," ").replace(Aa,""):""},string:function(a){return M(a)?a:"string"===typeof a?a.replace(Nb," "):a}});var za=function(a,b,c,d){if(0!==a&&(!a||"-"===a))return-Infinity;b&&(a=Pb(a,b));a.replace&&(c&&(a=a.replace(c,"")),d&&(a=a.replace(d,"")));return 1*a};h.extend(x.type.order,{"date-pre":function(a){a=Date.parse(a);return isNaN(a)?-Infinity:a},"html-pre":function(a){return M(a)?
-"":a.replace?a.replace(/<.*?>/g,"").toLowerCase():a+""},"string-pre":function(a){return M(a)?"":"string"===typeof a?a.toLowerCase():!a.toString?"":a.toString()},"string-asc":function(a,b){return ab?1:0},"string-desc":function(a,b){return ab?-1:0}});Da("");h.extend(!0,n.ext.renderer,{header:{_:function(a,b,c,d){h(a.nTable).on("order.dt.DT",function(e,f,g,h){if(a===f){e=c.idx;b.removeClass(c.sSortingClass+" "+d.sSortAsc+" "+d.sSortDesc).addClass(h[e]=="asc"?d.sSortAsc:h[e]=="desc"?d.sSortDesc:
-c.sSortingClass)}})},jqueryui:function(a,b,c,d){h("").addClass(d.sSortJUIWrapper).append(b.contents()).append(h("").addClass(d.sSortIcon+" "+c.sSortingClassJUI)).appendTo(b);h(a.nTable).on("order.dt.DT",function(e,f,g,h){if(a===f){e=c.idx;b.removeClass(d.sSortAsc+" "+d.sSortDesc).addClass(h[e]=="asc"?d.sSortAsc:h[e]=="desc"?d.sSortDesc:c.sSortingClass);b.find("span."+d.sSortIcon).removeClass(d.sSortJUIAsc+" "+d.sSortJUIDesc+" "+d.sSortJUI+" "+d.sSortJUIAscAllowed+" "+d.sSortJUIDescAllowed).addClass(h[e]==
-"asc"?d.sSortJUIAsc:h[e]=="desc"?d.sSortJUIDesc:c.sSortingClassJUI)}})}}});var eb=function(a){return"string"===typeof a?a.replace(//g,">").replace(/"/g,"""):a};n.render={number:function(a,b,c,d,e){return{display:function(f){if("number"!==typeof f&&"string"!==typeof f)return f;var g=0>f?"-":"",h=parseFloat(f);if(isNaN(h))return eb(f);h=h.toFixed(c);f=Math.abs(h);h=parseInt(f,10);f=c?b+(f-h).toFixed(c).substring(2):"";return g+(d||"")+h.toString().replace(/\B(?=(\d{3})+(?!\d))/g,
-a)+f+(e||"")}}},text:function(){return{display:eb,filter:eb}}};h.extend(n.ext.internal,{_fnExternApiFunc:Mb,_fnBuildAjax:sa,_fnAjaxUpdate:mb,_fnAjaxParameters:vb,_fnAjaxUpdateDraw:wb,_fnAjaxDataSrc:ta,_fnAddColumn:Ea,_fnColumnOptions:ka,_fnAdjustColumnSizing:$,_fnVisibleToColumnIndex:aa,_fnColumnIndexToVisible:ba,_fnVisbleColumns:V,_fnGetColumns:ma,_fnColumnTypes:Ga,_fnApplyColumnDefs:jb,_fnHungarianMap:Z,_fnCamelToHungarian:J,_fnLanguageCompat:Ca,_fnBrowserDetect:hb,_fnAddData:O,_fnAddTr:na,_fnNodeToDataIndex:function(a,
-b){return b._DT_RowIndex!==k?b._DT_RowIndex:null},_fnNodeToColumnIndex:function(a,b,c){return h.inArray(c,a.aoData[b].anCells)},_fnGetCellData:B,_fnSetCellData:kb,_fnSplitObjNotation:Ja,_fnGetObjectDataFn:S,_fnSetObjectDataFn:N,_fnGetDataMaster:Ka,_fnClearTable:oa,_fnDeleteIndex:pa,_fnInvalidate:da,_fnGetRowElements:Ia,_fnCreateTr:Ha,_fnBuildHead:lb,_fnDrawHead:fa,_fnDraw:P,_fnReDraw:T,_fnAddOptionsHtml:ob,_fnDetectHeader:ea,_fnGetUniqueThs:ra,_fnFeatureHtmlFilter:qb,_fnFilterComplete:ga,_fnFilterCustom:zb,
-_fnFilterColumn:yb,_fnFilter:xb,_fnFilterCreateSearch:Pa,_fnEscapeRegex:Qa,_fnFilterData:Ab,_fnFeatureHtmlInfo:tb,_fnUpdateInfo:Db,_fnInfoMacros:Eb,_fnInitialise:ha,_fnInitComplete:ua,_fnLengthChange:Ra,_fnFeatureHtmlLength:pb,_fnFeatureHtmlPaginate:ub,_fnPageChange:Ta,_fnFeatureHtmlProcessing:rb,_fnProcessingDisplay:C,_fnFeatureHtmlTable:sb,_fnScrollDraw:la,_fnApplyToChildren:I,_fnCalculateColumnWidths:Fa,_fnThrottle:Oa,_fnConvertToWidth:Fb,_fnGetWidestNode:Gb,_fnGetMaxLenString:Hb,_fnStringToCss:v,
-_fnSortFlatten:X,_fnSort:nb,_fnSortAria:Jb,_fnSortListener:Va,_fnSortAttachListener:Ma,_fnSortingClasses:wa,_fnSortData:Ib,_fnSaveState:xa,_fnLoadState:Kb,_fnSettingsFromNode:ya,_fnLog:K,_fnMap:F,_fnBindAction:Wa,_fnCallbackReg:z,_fnCallbackFire:r,_fnLengthOverflow:Sa,_fnRenderer:Na,_fnDataSource:y,_fnRowAttributes:La,_fnExtend:Xa,_fnCalculateEnd:function(){}});h.fn.dataTable=n;n.$=h;h.fn.dataTableSettings=n.settings;h.fn.dataTableExt=n.ext;h.fn.DataTable=function(a){return h(this).dataTable(a).api()};
-h.each(n,function(a,b){h.fn.DataTable[a]=b});return h.fn.dataTable});
diff --git a/docs/articles/antaresH5_files/htmlwidgets-1.5.1/htmlwidgets.js b/docs/articles/antaresH5_files/htmlwidgets-1.5.1/htmlwidgets.js
deleted file mode 100644
index 6f3d672d..00000000
--- a/docs/articles/antaresH5_files/htmlwidgets-1.5.1/htmlwidgets.js
+++ /dev/null
@@ -1,903 +0,0 @@
-(function() {
- // If window.HTMLWidgets is already defined, then use it; otherwise create a
- // new object. This allows preceding code to set options that affect the
- // initialization process (though none currently exist).
- window.HTMLWidgets = window.HTMLWidgets || {};
-
- // See if we're running in a viewer pane. If not, we're in a web browser.
- var viewerMode = window.HTMLWidgets.viewerMode =
- /\bviewer_pane=1\b/.test(window.location);
-
- // See if we're running in Shiny mode. If not, it's a static document.
- // Note that static widgets can appear in both Shiny and static modes, but
- // obviously, Shiny widgets can only appear in Shiny apps/documents.
- var shinyMode = window.HTMLWidgets.shinyMode =
- typeof(window.Shiny) !== "undefined" && !!window.Shiny.outputBindings;
-
- // We can't count on jQuery being available, so we implement our own
- // version if necessary.
- function querySelectorAll(scope, selector) {
- if (typeof(jQuery) !== "undefined" && scope instanceof jQuery) {
- return scope.find(selector);
- }
- if (scope.querySelectorAll) {
- return scope.querySelectorAll(selector);
- }
- }
-
- function asArray(value) {
- if (value === null)
- return [];
- if ($.isArray(value))
- return value;
- return [value];
- }
-
- // Implement jQuery's extend
- function extend(target /*, ... */) {
- if (arguments.length == 1) {
- return target;
- }
- for (var i = 1; i < arguments.length; i++) {
- var source = arguments[i];
- for (var prop in source) {
- if (source.hasOwnProperty(prop)) {
- target[prop] = source[prop];
- }
- }
- }
- return target;
- }
-
- // IE8 doesn't support Array.forEach.
- function forEach(values, callback, thisArg) {
- if (values.forEach) {
- values.forEach(callback, thisArg);
- } else {
- for (var i = 0; i < values.length; i++) {
- callback.call(thisArg, values[i], i, values);
- }
- }
- }
-
- // Replaces the specified method with the return value of funcSource.
- //
- // Note that funcSource should not BE the new method, it should be a function
- // that RETURNS the new method. funcSource receives a single argument that is
- // the overridden method, it can be called from the new method. The overridden
- // method can be called like a regular function, it has the target permanently
- // bound to it so "this" will work correctly.
- function overrideMethod(target, methodName, funcSource) {
- var superFunc = target[methodName] || function() {};
- var superFuncBound = function() {
- return superFunc.apply(target, arguments);
- };
- target[methodName] = funcSource(superFuncBound);
- }
-
- // Add a method to delegator that, when invoked, calls
- // delegatee.methodName. If there is no such method on
- // the delegatee, but there was one on delegator before
- // delegateMethod was called, then the original version
- // is invoked instead.
- // For example:
- //
- // var a = {
- // method1: function() { console.log('a1'); }
- // method2: function() { console.log('a2'); }
- // };
- // var b = {
- // method1: function() { console.log('b1'); }
- // };
- // delegateMethod(a, b, "method1");
- // delegateMethod(a, b, "method2");
- // a.method1();
- // a.method2();
- //
- // The output would be "b1", "a2".
- function delegateMethod(delegator, delegatee, methodName) {
- var inherited = delegator[methodName];
- delegator[methodName] = function() {
- var target = delegatee;
- var method = delegatee[methodName];
-
- // The method doesn't exist on the delegatee. Instead,
- // call the method on the delegator, if it exists.
- if (!method) {
- target = delegator;
- method = inherited;
- }
-
- if (method) {
- return method.apply(target, arguments);
- }
- };
- }
-
- // Implement a vague facsimilie of jQuery's data method
- function elementData(el, name, value) {
- if (arguments.length == 2) {
- return el["htmlwidget_data_" + name];
- } else if (arguments.length == 3) {
- el["htmlwidget_data_" + name] = value;
- return el;
- } else {
- throw new Error("Wrong number of arguments for elementData: " +
- arguments.length);
- }
- }
-
- // http://stackoverflow.com/questions/3446170/escape-string-for-use-in-javascript-regex
- function escapeRegExp(str) {
- return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
- }
-
- function hasClass(el, className) {
- var re = new RegExp("\\b" + escapeRegExp(className) + "\\b");
- return re.test(el.className);
- }
-
- // elements - array (or array-like object) of HTML elements
- // className - class name to test for
- // include - if true, only return elements with given className;
- // if false, only return elements *without* given className
- function filterByClass(elements, className, include) {
- var results = [];
- for (var i = 0; i < elements.length; i++) {
- if (hasClass(elements[i], className) == include)
- results.push(elements[i]);
- }
- return results;
- }
-
- function on(obj, eventName, func) {
- if (obj.addEventListener) {
- obj.addEventListener(eventName, func, false);
- } else if (obj.attachEvent) {
- obj.attachEvent(eventName, func);
- }
- }
-
- function off(obj, eventName, func) {
- if (obj.removeEventListener)
- obj.removeEventListener(eventName, func, false);
- else if (obj.detachEvent) {
- obj.detachEvent(eventName, func);
- }
- }
-
- // Translate array of values to top/right/bottom/left, as usual with
- // the "padding" CSS property
- // https://developer.mozilla.org/en-US/docs/Web/CSS/padding
- function unpackPadding(value) {
- if (typeof(value) === "number")
- value = [value];
- if (value.length === 1) {
- return {top: value[0], right: value[0], bottom: value[0], left: value[0]};
- }
- if (value.length === 2) {
- return {top: value[0], right: value[1], bottom: value[0], left: value[1]};
- }
- if (value.length === 3) {
- return {top: value[0], right: value[1], bottom: value[2], left: value[1]};
- }
- if (value.length === 4) {
- return {top: value[0], right: value[1], bottom: value[2], left: value[3]};
- }
- }
-
- // Convert an unpacked padding object to a CSS value
- function paddingToCss(paddingObj) {
- return paddingObj.top + "px " + paddingObj.right + "px " + paddingObj.bottom + "px " + paddingObj.left + "px";
- }
-
- // Makes a number suitable for CSS
- function px(x) {
- if (typeof(x) === "number")
- return x + "px";
- else
- return x;
- }
-
- // Retrieves runtime widget sizing information for an element.
- // The return value is either null, or an object with fill, padding,
- // defaultWidth, defaultHeight fields.
- function sizingPolicy(el) {
- var sizingEl = document.querySelector("script[data-for='" + el.id + "'][type='application/htmlwidget-sizing']");
- if (!sizingEl)
- return null;
- var sp = JSON.parse(sizingEl.textContent || sizingEl.text || "{}");
- if (viewerMode) {
- return sp.viewer;
- } else {
- return sp.browser;
- }
- }
-
- // @param tasks Array of strings (or falsy value, in which case no-op).
- // Each element must be a valid JavaScript expression that yields a
- // function. Or, can be an array of objects with "code" and "data"
- // properties; in this case, the "code" property should be a string
- // of JS that's an expr that yields a function, and "data" should be
- // an object that will be added as an additional argument when that
- // function is called.
- // @param target The object that will be "this" for each function
- // execution.
- // @param args Array of arguments to be passed to the functions. (The
- // same arguments will be passed to all functions.)
- function evalAndRun(tasks, target, args) {
- if (tasks) {
- forEach(tasks, function(task) {
- var theseArgs = args;
- if (typeof(task) === "object") {
- theseArgs = theseArgs.concat([task.data]);
- task = task.code;
- }
- var taskFunc = tryEval(task);
- if (typeof(taskFunc) !== "function") {
- throw new Error("Task must be a function! Source:\n" + task);
- }
- taskFunc.apply(target, theseArgs);
- });
- }
- }
-
- // Attempt eval() both with and without enclosing in parentheses.
- // Note that enclosing coerces a function declaration into
- // an expression that eval() can parse
- // (otherwise, a SyntaxError is thrown)
- function tryEval(code) {
- var result = null;
- try {
- result = eval(code);
- } catch(error) {
- if (!error instanceof SyntaxError) {
- throw error;
- }
- try {
- result = eval("(" + code + ")");
- } catch(e) {
- if (e instanceof SyntaxError) {
- throw error;
- } else {
- throw e;
- }
- }
- }
- return result;
- }
-
- function initSizing(el) {
- var sizing = sizingPolicy(el);
- if (!sizing)
- return;
-
- var cel = document.getElementById("htmlwidget_container");
- if (!cel)
- return;
-
- if (typeof(sizing.padding) !== "undefined") {
- document.body.style.margin = "0";
- document.body.style.padding = paddingToCss(unpackPadding(sizing.padding));
- }
-
- if (sizing.fill) {
- document.body.style.overflow = "hidden";
- document.body.style.width = "100%";
- document.body.style.height = "100%";
- document.documentElement.style.width = "100%";
- document.documentElement.style.height = "100%";
- if (cel) {
- cel.style.position = "absolute";
- var pad = unpackPadding(sizing.padding);
- cel.style.top = pad.top + "px";
- cel.style.right = pad.right + "px";
- cel.style.bottom = pad.bottom + "px";
- cel.style.left = pad.left + "px";
- el.style.width = "100%";
- el.style.height = "100%";
- }
-
- return {
- getWidth: function() { return cel.offsetWidth; },
- getHeight: function() { return cel.offsetHeight; }
- };
-
- } else {
- el.style.width = px(sizing.width);
- el.style.height = px(sizing.height);
-
- return {
- getWidth: function() { return el.offsetWidth; },
- getHeight: function() { return el.offsetHeight; }
- };
- }
- }
-
- // Default implementations for methods
- var defaults = {
- find: function(scope) {
- return querySelectorAll(scope, "." + this.name);
- },
- renderError: function(el, err) {
- var $el = $(el);
-
- this.clearError(el);
-
- // Add all these error classes, as Shiny does
- var errClass = "shiny-output-error";
- if (err.type !== null) {
- // use the classes of the error condition as CSS class names
- errClass = errClass + " " + $.map(asArray(err.type), function(type) {
- return errClass + "-" + type;
- }).join(" ");
- }
- errClass = errClass + " htmlwidgets-error";
-
- // Is el inline or block? If inline or inline-block, just display:none it
- // and add an inline error.
- var display = $el.css("display");
- $el.data("restore-display-mode", display);
-
- if (display === "inline" || display === "inline-block") {
- $el.hide();
- if (err.message !== "") {
- var errorSpan = $("").addClass(errClass);
- errorSpan.text(err.message);
- $el.after(errorSpan);
- }
- } else if (display === "block") {
- // If block, add an error just after the el, set visibility:none on the
- // el, and position the error to be on top of the el.
- // Mark it with a unique ID and CSS class so we can remove it later.
- $el.css("visibility", "hidden");
- if (err.message !== "") {
- var errorDiv = $("
").addClass(errClass).css("position", "absolute")
- .css("top", el.offsetTop)
- .css("left", el.offsetLeft)
- // setting width can push out the page size, forcing otherwise
- // unnecessary scrollbars to appear and making it impossible for
- // the element to shrink; so use max-width instead
- .css("maxWidth", el.offsetWidth)
- .css("height", el.offsetHeight);
- errorDiv.text(err.message);
- $el.after(errorDiv);
-
- // Really dumb way to keep the size/position of the error in sync with
- // the parent element as the window is resized or whatever.
- var intId = setInterval(function() {
- if (!errorDiv[0].parentElement) {
- clearInterval(intId);
- return;
- }
- errorDiv
- .css("top", el.offsetTop)
- .css("left", el.offsetLeft)
- .css("maxWidth", el.offsetWidth)
- .css("height", el.offsetHeight);
- }, 500);
- }
- }
- },
- clearError: function(el) {
- var $el = $(el);
- var display = $el.data("restore-display-mode");
- $el.data("restore-display-mode", null);
-
- if (display === "inline" || display === "inline-block") {
- if (display)
- $el.css("display", display);
- $(el.nextSibling).filter(".htmlwidgets-error").remove();
- } else if (display === "block"){
- $el.css("visibility", "inherit");
- $(el.nextSibling).filter(".htmlwidgets-error").remove();
- }
- },
- sizing: {}
- };
-
- // Called by widget bindings to register a new type of widget. The definition
- // object can contain the following properties:
- // - name (required) - A string indicating the binding name, which will be
- // used by default as the CSS classname to look for.
- // - initialize (optional) - A function(el) that will be called once per
- // widget element; if a value is returned, it will be passed as the third
- // value to renderValue.
- // - renderValue (required) - A function(el, data, initValue) that will be
- // called with data. Static contexts will cause this to be called once per
- // element; Shiny apps will cause this to be called multiple times per
- // element, as the data changes.
- window.HTMLWidgets.widget = function(definition) {
- if (!definition.name) {
- throw new Error("Widget must have a name");
- }
- if (!definition.type) {
- throw new Error("Widget must have a type");
- }
- // Currently we only support output widgets
- if (definition.type !== "output") {
- throw new Error("Unrecognized widget type '" + definition.type + "'");
- }
- // TODO: Verify that .name is a valid CSS classname
-
- // Support new-style instance-bound definitions. Old-style class-bound
- // definitions have one widget "object" per widget per type/class of
- // widget; the renderValue and resize methods on such widget objects
- // take el and instance arguments, because the widget object can't
- // store them. New-style instance-bound definitions have one widget
- // object per widget instance; the definition that's passed in doesn't
- // provide renderValue or resize methods at all, just the single method
- // factory(el, width, height)
- // which returns an object that has renderValue(x) and resize(w, h).
- // This enables a far more natural programming style for the widget
- // author, who can store per-instance state using either OO-style
- // instance fields or functional-style closure variables (I guess this
- // is in contrast to what can only be called C-style pseudo-OO which is
- // what we required before).
- if (definition.factory) {
- definition = createLegacyDefinitionAdapter(definition);
- }
-
- if (!definition.renderValue) {
- throw new Error("Widget must have a renderValue function");
- }
-
- // For static rendering (non-Shiny), use a simple widget registration
- // scheme. We also use this scheme for Shiny apps/documents that also
- // contain static widgets.
- window.HTMLWidgets.widgets = window.HTMLWidgets.widgets || [];
- // Merge defaults into the definition; don't mutate the original definition.
- var staticBinding = extend({}, defaults, definition);
- overrideMethod(staticBinding, "find", function(superfunc) {
- return function(scope) {
- var results = superfunc(scope);
- // Filter out Shiny outputs, we only want the static kind
- return filterByClass(results, "html-widget-output", false);
- };
- });
- window.HTMLWidgets.widgets.push(staticBinding);
-
- if (shinyMode) {
- // Shiny is running. Register the definition with an output binding.
- // The definition itself will not be the output binding, instead
- // we will make an output binding object that delegates to the
- // definition. This is because we foolishly used the same method
- // name (renderValue) for htmlwidgets definition and Shiny bindings
- // but they actually have quite different semantics (the Shiny
- // bindings receive data that includes lots of metadata that it
- // strips off before calling htmlwidgets renderValue). We can't
- // just ignore the difference because in some widgets it's helpful
- // to call this.renderValue() from inside of resize(), and if
- // we're not delegating, then that call will go to the Shiny
- // version instead of the htmlwidgets version.
-
- // Merge defaults with definition, without mutating either.
- var bindingDef = extend({}, defaults, definition);
-
- // This object will be our actual Shiny binding.
- var shinyBinding = new Shiny.OutputBinding();
-
- // With a few exceptions, we'll want to simply use the bindingDef's
- // version of methods if they are available, otherwise fall back to
- // Shiny's defaults. NOTE: If Shiny's output bindings gain additional
- // methods in the future, and we want them to be overrideable by
- // HTMLWidget binding definitions, then we'll need to add them to this
- // list.
- delegateMethod(shinyBinding, bindingDef, "getId");
- delegateMethod(shinyBinding, bindingDef, "onValueChange");
- delegateMethod(shinyBinding, bindingDef, "onValueError");
- delegateMethod(shinyBinding, bindingDef, "renderError");
- delegateMethod(shinyBinding, bindingDef, "clearError");
- delegateMethod(shinyBinding, bindingDef, "showProgress");
-
- // The find, renderValue, and resize are handled differently, because we
- // want to actually decorate the behavior of the bindingDef methods.
-
- shinyBinding.find = function(scope) {
- var results = bindingDef.find(scope);
-
- // Only return elements that are Shiny outputs, not static ones
- var dynamicResults = results.filter(".html-widget-output");
-
- // It's possible that whatever caused Shiny to think there might be
- // new dynamic outputs, also caused there to be new static outputs.
- // Since there might be lots of different htmlwidgets bindings, we
- // schedule execution for later--no need to staticRender multiple
- // times.
- if (results.length !== dynamicResults.length)
- scheduleStaticRender();
-
- return dynamicResults;
- };
-
- // Wrap renderValue to handle initialization, which unfortunately isn't
- // supported natively by Shiny at the time of this writing.
-
- shinyBinding.renderValue = function(el, data) {
- Shiny.renderDependencies(data.deps);
- // Resolve strings marked as javascript literals to objects
- if (!(data.evals instanceof Array)) data.evals = [data.evals];
- for (var i = 0; data.evals && i < data.evals.length; i++) {
- window.HTMLWidgets.evaluateStringMember(data.x, data.evals[i]);
- }
- if (!bindingDef.renderOnNullValue) {
- if (data.x === null) {
- el.style.visibility = "hidden";
- return;
- } else {
- el.style.visibility = "inherit";
- }
- }
- if (!elementData(el, "initialized")) {
- initSizing(el);
-
- elementData(el, "initialized", true);
- if (bindingDef.initialize) {
- var result = bindingDef.initialize(el, el.offsetWidth,
- el.offsetHeight);
- elementData(el, "init_result", result);
- }
- }
- bindingDef.renderValue(el, data.x, elementData(el, "init_result"));
- evalAndRun(data.jsHooks.render, elementData(el, "init_result"), [el, data.x]);
- };
-
- // Only override resize if bindingDef implements it
- if (bindingDef.resize) {
- shinyBinding.resize = function(el, width, height) {
- // Shiny can call resize before initialize/renderValue have been
- // called, which doesn't make sense for widgets.
- if (elementData(el, "initialized")) {
- bindingDef.resize(el, width, height, elementData(el, "init_result"));
- }
- };
- }
-
- Shiny.outputBindings.register(shinyBinding, bindingDef.name);
- }
- };
-
- var scheduleStaticRenderTimerId = null;
- function scheduleStaticRender() {
- if (!scheduleStaticRenderTimerId) {
- scheduleStaticRenderTimerId = setTimeout(function() {
- scheduleStaticRenderTimerId = null;
- window.HTMLWidgets.staticRender();
- }, 1);
- }
- }
-
- // Render static widgets after the document finishes loading
- // Statically render all elements that are of this widget's class
- window.HTMLWidgets.staticRender = function() {
- var bindings = window.HTMLWidgets.widgets || [];
- forEach(bindings, function(binding) {
- var matches = binding.find(document.documentElement);
- forEach(matches, function(el) {
- var sizeObj = initSizing(el, binding);
-
- if (hasClass(el, "html-widget-static-bound"))
- return;
- el.className = el.className + " html-widget-static-bound";
-
- var initResult;
- if (binding.initialize) {
- initResult = binding.initialize(el,
- sizeObj ? sizeObj.getWidth() : el.offsetWidth,
- sizeObj ? sizeObj.getHeight() : el.offsetHeight
- );
- elementData(el, "init_result", initResult);
- }
-
- if (binding.resize) {
- var lastSize = {
- w: sizeObj ? sizeObj.getWidth() : el.offsetWidth,
- h: sizeObj ? sizeObj.getHeight() : el.offsetHeight
- };
- var resizeHandler = function(e) {
- var size = {
- w: sizeObj ? sizeObj.getWidth() : el.offsetWidth,
- h: sizeObj ? sizeObj.getHeight() : el.offsetHeight
- };
- if (size.w === 0 && size.h === 0)
- return;
- if (size.w === lastSize.w && size.h === lastSize.h)
- return;
- lastSize = size;
- binding.resize(el, size.w, size.h, initResult);
- };
-
- on(window, "resize", resizeHandler);
-
- // This is needed for cases where we're running in a Shiny
- // app, but the widget itself is not a Shiny output, but
- // rather a simple static widget. One example of this is
- // an rmarkdown document that has runtime:shiny and widget
- // that isn't in a render function. Shiny only knows to
- // call resize handlers for Shiny outputs, not for static
- // widgets, so we do it ourselves.
- if (window.jQuery) {
- window.jQuery(document).on(
- "shown.htmlwidgets shown.bs.tab.htmlwidgets shown.bs.collapse.htmlwidgets",
- resizeHandler
- );
- window.jQuery(document).on(
- "hidden.htmlwidgets hidden.bs.tab.htmlwidgets hidden.bs.collapse.htmlwidgets",
- resizeHandler
- );
- }
-
- // This is needed for the specific case of ioslides, which
- // flips slides between display:none and display:block.
- // Ideally we would not have to have ioslide-specific code
- // here, but rather have ioslides raise a generic event,
- // but the rmarkdown package just went to CRAN so the
- // window to getting that fixed may be long.
- if (window.addEventListener) {
- // It's OK to limit this to window.addEventListener
- // browsers because ioslides itself only supports
- // such browsers.
- on(document, "slideenter", resizeHandler);
- on(document, "slideleave", resizeHandler);
- }
- }
-
- var scriptData = document.querySelector("script[data-for='" + el.id + "'][type='application/json']");
- if (scriptData) {
- var data = JSON.parse(scriptData.textContent || scriptData.text);
- // Resolve strings marked as javascript literals to objects
- if (!(data.evals instanceof Array)) data.evals = [data.evals];
- for (var k = 0; data.evals && k < data.evals.length; k++) {
- window.HTMLWidgets.evaluateStringMember(data.x, data.evals[k]);
- }
- binding.renderValue(el, data.x, initResult);
- evalAndRun(data.jsHooks.render, initResult, [el, data.x]);
- }
- });
- });
-
- invokePostRenderHandlers();
- }
-
-
- function has_jQuery3() {
- if (!window.jQuery) {
- return false;
- }
- var $version = window.jQuery.fn.jquery;
- var $major_version = parseInt($version.split(".")[0]);
- return $major_version >= 3;
- }
-
- /*
- / Shiny 1.4 bumped jQuery from 1.x to 3.x which means jQuery's
- / on-ready handler (i.e., $(fn)) is now asyncronous (i.e., it now
- / really means $(setTimeout(fn)).
- / https://jquery.com/upgrade-guide/3.0/#breaking-change-document-ready-handlers-are-now-asynchronous
- /
- / Since Shiny uses $() to schedule initShiny, shiny>=1.4 calls initShiny
- / one tick later than it did before, which means staticRender() is
- / called renderValue() earlier than (advanced) widget authors might be expecting.
- / https://github.com/rstudio/shiny/issues/2630
- /
- / For a concrete example, leaflet has some methods (e.g., updateBounds)
- / which reference Shiny methods registered in initShiny (e.g., setInputValue).
- / Since leaflet is privy to this life-cycle, it knows to use setTimeout() to
- / delay execution of those methods (until Shiny methods are ready)
- / https://github.com/rstudio/leaflet/blob/18ec981/javascript/src/index.js#L266-L268
- /
- / Ideally widget authors wouldn't need to use this setTimeout() hack that
- / leaflet uses to call Shiny methods on a staticRender(). In the long run,
- / the logic initShiny should be broken up so that method registration happens
- / right away, but binding happens later.
- */
- function maybeStaticRenderLater() {
- if (shinyMode && has_jQuery3()) {
- window.jQuery(window.HTMLWidgets.staticRender);
- } else {
- window.HTMLWidgets.staticRender();
- }
- }
-
- if (document.addEventListener) {
- document.addEventListener("DOMContentLoaded", function() {
- document.removeEventListener("DOMContentLoaded", arguments.callee, false);
- maybeStaticRenderLater();
- }, false);
- } else if (document.attachEvent) {
- document.attachEvent("onreadystatechange", function() {
- if (document.readyState === "complete") {
- document.detachEvent("onreadystatechange", arguments.callee);
- maybeStaticRenderLater();
- }
- });
- }
-
-
- window.HTMLWidgets.getAttachmentUrl = function(depname, key) {
- // If no key, default to the first item
- if (typeof(key) === "undefined")
- key = 1;
-
- var link = document.getElementById(depname + "-" + key + "-attachment");
- if (!link) {
- throw new Error("Attachment " + depname + "/" + key + " not found in document");
- }
- return link.getAttribute("href");
- };
-
- window.HTMLWidgets.dataframeToD3 = function(df) {
- var names = [];
- var length;
- for (var name in df) {
- if (df.hasOwnProperty(name))
- names.push(name);
- if (typeof(df[name]) !== "object" || typeof(df[name].length) === "undefined") {
- throw new Error("All fields must be arrays");
- } else if (typeof(length) !== "undefined" && length !== df[name].length) {
- throw new Error("All fields must be arrays of the same length");
- }
- length = df[name].length;
- }
- var results = [];
- var item;
- for (var row = 0; row < length; row++) {
- item = {};
- for (var col = 0; col < names.length; col++) {
- item[names[col]] = df[names[col]][row];
- }
- results.push(item);
- }
- return results;
- };
-
- window.HTMLWidgets.transposeArray2D = function(array) {
- if (array.length === 0) return array;
- var newArray = array[0].map(function(col, i) {
- return array.map(function(row) {
- return row[i]
- })
- });
- return newArray;
- };
- // Split value at splitChar, but allow splitChar to be escaped
- // using escapeChar. Any other characters escaped by escapeChar
- // will be included as usual (including escapeChar itself).
- function splitWithEscape(value, splitChar, escapeChar) {
- var results = [];
- var escapeMode = false;
- var currentResult = "";
- for (var pos = 0; pos < value.length; pos++) {
- if (!escapeMode) {
- if (value[pos] === splitChar) {
- results.push(currentResult);
- currentResult = "";
- } else if (value[pos] === escapeChar) {
- escapeMode = true;
- } else {
- currentResult += value[pos];
- }
- } else {
- currentResult += value[pos];
- escapeMode = false;
- }
- }
- if (currentResult !== "") {
- results.push(currentResult);
- }
- return results;
- }
- // Function authored by Yihui/JJ Allaire
- window.HTMLWidgets.evaluateStringMember = function(o, member) {
- var parts = splitWithEscape(member, '.', '\\');
- for (var i = 0, l = parts.length; i < l; i++) {
- var part = parts[i];
- // part may be a character or 'numeric' member name
- if (o !== null && typeof o === "object" && part in o) {
- if (i == (l - 1)) { // if we are at the end of the line then evalulate
- if (typeof o[part] === "string")
- o[part] = tryEval(o[part]);
- } else { // otherwise continue to next embedded object
- o = o[part];
- }
- }
- }
- };
-
- // Retrieve the HTMLWidget instance (i.e. the return value of an
- // HTMLWidget binding's initialize() or factory() function)
- // associated with an element, or null if none.
- window.HTMLWidgets.getInstance = function(el) {
- return elementData(el, "init_result");
- };
-
- // Finds the first element in the scope that matches the selector,
- // and returns the HTMLWidget instance (i.e. the return value of
- // an HTMLWidget binding's initialize() or factory() function)
- // associated with that element, if any. If no element matches the
- // selector, or the first matching element has no HTMLWidget
- // instance associated with it, then null is returned.
- //
- // The scope argument is optional, and defaults to window.document.
- window.HTMLWidgets.find = function(scope, selector) {
- if (arguments.length == 1) {
- selector = scope;
- scope = document;
- }
-
- var el = scope.querySelector(selector);
- if (el === null) {
- return null;
- } else {
- return window.HTMLWidgets.getInstance(el);
- }
- };
-
- // Finds all elements in the scope that match the selector, and
- // returns the HTMLWidget instances (i.e. the return values of
- // an HTMLWidget binding's initialize() or factory() function)
- // associated with the elements, in an array. If elements that
- // match the selector don't have an associated HTMLWidget
- // instance, the returned array will contain nulls.
- //
- // The scope argument is optional, and defaults to window.document.
- window.HTMLWidgets.findAll = function(scope, selector) {
- if (arguments.length == 1) {
- selector = scope;
- scope = document;
- }
-
- var nodes = scope.querySelectorAll(selector);
- var results = [];
- for (var i = 0; i < nodes.length; i++) {
- results.push(window.HTMLWidgets.getInstance(nodes[i]));
- }
- return results;
- };
-
- var postRenderHandlers = [];
- function invokePostRenderHandlers() {
- while (postRenderHandlers.length) {
- var handler = postRenderHandlers.shift();
- if (handler) {
- handler();
- }
- }
- }
-
- // Register the given callback function to be invoked after the
- // next time static widgets are rendered.
- window.HTMLWidgets.addPostRenderHandler = function(callback) {
- postRenderHandlers.push(callback);
- };
-
- // Takes a new-style instance-bound definition, and returns an
- // old-style class-bound definition. This saves us from having
- // to rewrite all the logic in this file to accomodate both
- // types of definitions.
- function createLegacyDefinitionAdapter(defn) {
- var result = {
- name: defn.name,
- type: defn.type,
- initialize: function(el, width, height) {
- return defn.factory(el, width, height);
- },
- renderValue: function(el, x, instance) {
- return instance.renderValue(x);
- },
- resize: function(el, width, height, instance) {
- return instance.resize(width, height);
- }
- };
-
- if (defn.find)
- result.find = defn.find;
- if (defn.renderError)
- result.renderError = defn.renderError;
- if (defn.clearError)
- result.clearError = defn.clearError;
-
- return result;
- }
-})();
-
diff --git a/docs/articles/antaresH5_files/jquery-1.12.4/LICENSE.txt b/docs/articles/antaresH5_files/jquery-1.12.4/LICENSE.txt
deleted file mode 100644
index 5bf4f5e6..00000000
--- a/docs/articles/antaresH5_files/jquery-1.12.4/LICENSE.txt
+++ /dev/null
@@ -1,37 +0,0 @@
-Copyright 2005, 2014 jQuery Foundation and other contributors,
-https://jquery.org/
-
-This software consists of voluntary contributions made by many
-individuals. For exact contribution history, see the revision history
-available at https://github.com/jquery/jquery
-
-The following license applies to all parts of this software except as
-documented below:
-
-====
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-====
-
-All files located in the node_modules and external directories are
-externally maintained libraries used by this software which have their
-own licenses; we recommend you read them, as their terms may differ from
-the terms above.
diff --git a/docs/articles/antaresH5_files/jquery-1.12.4/jquery.min.js b/docs/articles/antaresH5_files/jquery-1.12.4/jquery.min.js
deleted file mode 100644
index e8364758..00000000
--- a/docs/articles/antaresH5_files/jquery-1.12.4/jquery.min.js
+++ /dev/null
@@ -1,5 +0,0 @@
-/*! jQuery v1.12.4 | (c) jQuery Foundation | jquery.org/license */
-!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=a.document,e=c.slice,f=c.concat,g=c.push,h=c.indexOf,i={},j=i.toString,k=i.hasOwnProperty,l={},m="1.12.4",n=function(a,b){return new n.fn.init(a,b)},o=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,p=/^-ms-/,q=/-([\da-z])/gi,r=function(a,b){return b.toUpperCase()};n.fn=n.prototype={jquery:m,constructor:n,selector:"",length:0,toArray:function(){return e.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:e.call(this)},pushStack:function(a){var b=n.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a){return n.each(this,a)},map:function(a){return this.pushStack(n.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(e.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor()},push:g,sort:c.sort,splice:c.splice},n.extend=n.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||n.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(n.isPlainObject(c)||(b=n.isArray(c)))?(b?(b=!1,f=a&&n.isArray(a)?a:[]):f=a&&n.isPlainObject(a)?a:{},g[d]=n.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},n.extend({expando:"jQuery"+(m+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===n.type(a)},isArray:Array.isArray||function(a){return"array"===n.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){var b=a&&a.toString();return!n.isArray(a)&&b-parseFloat(b)+1>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==n.type(a)||a.nodeType||n.isWindow(a))return!1;try{if(a.constructor&&!k.call(a,"constructor")&&!k.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(!l.ownFirst)for(b in a)return k.call(a,b);for(b in a);return void 0===b||k.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?i[j.call(a)]||"object":typeof a},globalEval:function(b){b&&n.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(p,"ms-").replace(q,r)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b){var c,d=0;if(s(a)){for(c=a.length;c>d;d++)if(b.call(a[d],d,a[d])===!1)break}else for(d in a)if(b.call(a[d],d,a[d])===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(o,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(s(Object(a))?n.merge(c,"string"==typeof a?[a]:a):g.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(h)return h.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,e,g=0,h=[];if(s(a))for(d=a.length;d>g;g++)e=b(a[g],g,c),null!=e&&h.push(e);else for(g in a)e=b(a[g],g,c),null!=e&&h.push(e);return f.apply([],h)},guid:1,proxy:function(a,b){var c,d,f;return"string"==typeof b&&(f=a[b],b=a,a=f),n.isFunction(a)?(c=e.call(arguments,2),d=function(){return a.apply(b||this,c.concat(e.call(arguments)))},d.guid=a.guid=a.guid||n.guid++,d):void 0},now:function(){return+new Date},support:l}),"function"==typeof Symbol&&(n.fn[Symbol.iterator]=c[Symbol.iterator]),n.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(a,b){i["[object "+b+"]"]=b.toLowerCase()});function s(a){var b=!!a&&"length"in a&&a.length,c=n.type(a);return"function"===c||n.isWindow(a)?!1:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var t=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ga(),z=ga(),A=ga(),B=function(a,b){return a===b&&(l=!0),0},C=1<<31,D={}.hasOwnProperty,E=[],F=E.pop,G=E.push,H=E.push,I=E.slice,J=function(a,b){for(var c=0,d=a.length;d>c;c++)if(a[c]===b)return c;return-1},K="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",L="[\\x20\\t\\r\\n\\f]",M="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",N="\\["+L+"*("+M+")(?:"+L+"*([*^$|!~]?=)"+L+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+M+"))|)"+L+"*\\]",O=":("+M+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+N+")*)|.*)\\)|)",P=new RegExp(L+"+","g"),Q=new RegExp("^"+L+"+|((?:^|[^\\\\])(?:\\\\.)*)"+L+"+$","g"),R=new RegExp("^"+L+"*,"+L+"*"),S=new RegExp("^"+L+"*([>+~]|"+L+")"+L+"*"),T=new RegExp("="+L+"*([^\\]'\"]*?)"+L+"*\\]","g"),U=new RegExp(O),V=new RegExp("^"+M+"$"),W={ID:new RegExp("^#("+M+")"),CLASS:new RegExp("^\\.("+M+")"),TAG:new RegExp("^("+M+"|[*])"),ATTR:new RegExp("^"+N),PSEUDO:new RegExp("^"+O),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+L+"*(even|odd|(([+-]|)(\\d*)n|)"+L+"*(?:([+-]|)"+L+"*(\\d+)|))"+L+"*\\)|)","i"),bool:new RegExp("^(?:"+K+")$","i"),needsContext:new RegExp("^"+L+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+L+"*((?:-\\d)?\\d*)"+L+"*\\)|)(?=[^-]|$)","i")},X=/^(?:input|select|textarea|button)$/i,Y=/^h\d$/i,Z=/^[^{]+\{\s*\[native \w/,$=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,_=/[+~]/,aa=/'|\\/g,ba=new RegExp("\\\\([\\da-f]{1,6}"+L+"?|("+L+")|.)","ig"),ca=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},da=function(){m()};try{H.apply(E=I.call(v.childNodes),v.childNodes),E[v.childNodes.length].nodeType}catch(ea){H={apply:E.length?function(a,b){G.apply(a,I.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fa(a,b,d,e){var f,h,j,k,l,o,r,s,w=b&&b.ownerDocument,x=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==x&&9!==x&&11!==x)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==x&&(o=$.exec(a)))if(f=o[1]){if(9===x){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(w&&(j=w.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(o[2])return H.apply(d,b.getElementsByTagName(a)),d;if((f=o[3])&&c.getElementsByClassName&&b.getElementsByClassName)return H.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==x)w=b,s=a;else if("object"!==b.nodeName.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(aa,"\\$&"):b.setAttribute("id",k=u),r=g(a),h=r.length,l=V.test(k)?"#"+k:"[id='"+k+"']";while(h--)r[h]=l+" "+qa(r[h]);s=r.join(","),w=_.test(a)&&oa(b.parentNode)||b}if(s)try{return H.apply(d,w.querySelectorAll(s)),d}catch(y){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(Q,"$1"),b,d,e)}function ga(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ha(a){return a[u]=!0,a}function ia(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ja(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function ka(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||C)-(~a.sourceIndex||C);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function la(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function na(a){return ha(function(b){return b=+b,ha(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function oa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=fa.support={},f=fa.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fa.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ia(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ia(function(a){return a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Z.test(n.getElementsByClassName),c.getById=ia(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}},d.filter.ID=function(a){var b=a.replace(ba,ca);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(ba,ca);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return"undefined"!=typeof b.getElementsByClassName&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=Z.test(n.querySelectorAll))&&(ia(function(a){o.appendChild(a).innerHTML="",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+L+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+L+"*(?:value|"+K+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ia(function(a){var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+L+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Z.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ia(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",O)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Z.test(o.compareDocumentPosition),t=b||Z.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument===v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?J(k,a)-J(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?J(k,a)-J(k,b):0;if(e===f)return ka(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?ka(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},fa.matches=function(a,b){return fa(a,null,null,b)},fa.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(T,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fa(b,n,null,[a]).length>0},fa.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fa.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&D.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fa.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fa.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fa.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fa.selectors={cacheLength:50,createPseudo:ha,match:W,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(ba,ca),a[3]=(a[3]||a[4]||a[5]||"").replace(ba,ca),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fa.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fa.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return W.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&U.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(ba,ca).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+L+")"+a+"("+L+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fa.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(P," ")+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeName.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fa.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ha(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=J(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ha(function(a){var b=[],c=[],d=h(a.replace(Q,"$1"));return d[u]?ha(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ha(function(a){return function(b){return fa(a,b).length>0}}),contains:ha(function(a){return a=a.replace(ba,ca),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ha(function(a){return V.test(a||"")||fa.error("unsupported lang: "+a),a=a.replace(ba,ca).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Y.test(a.nodeName)},input:function(a){return X.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:na(function(){return[0]}),last:na(function(a,b){return[b-1]}),eq:na(function(a,b,c){return[0>c?c+b:c]}),even:na(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:na(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:na(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:na(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function ra(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j,k=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(j=b[u]||(b[u]={}),i=j[b.uniqueID]||(j[b.uniqueID]={}),(h=i[d])&&h[0]===w&&h[1]===f)return k[2]=h[2];if(i[d]=k,k[2]=a(b,c,g))return!0}}}function sa(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function ta(a,b,c){for(var d=0,e=b.length;e>d;d++)fa(a,b[d],c);return c}function ua(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(c&&!c(f,d,e)||(g.push(f),j&&b.push(h)));return g}function va(a,b,c,d,e,f){return d&&!d[u]&&(d=va(d)),e&&!e[u]&&(e=va(e,f)),ha(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||ta(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ua(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ua(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?J(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ua(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):H.apply(g,r)})}function wa(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ra(function(a){return a===b},h,!0),l=ra(function(a){return J(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];f>i;i++)if(c=d.relative[a[i].type])m=[ra(sa(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return va(i>1&&sa(m),i>1&&qa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(Q,"$1"),c,e>i&&wa(a.slice(i,e)),f>e&&wa(a=a.slice(e)),f>e&&qa(a))}m.push(c)}return sa(m)}function xa(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=F.call(i));u=ua(u)}H.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&fa.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ha(f):f}return h=fa.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wa(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xa(e,d)),f.selector=a}return f},i=fa.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(ba,ca),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=W.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(ba,ca),_.test(j[0].type)&&oa(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qa(j),!a)return H.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,!b||_.test(a)&&oa(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ia(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ia(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||ja("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ia(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ja("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ia(function(a){return null==a.getAttribute("disabled")})||ja(K,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fa}(a);n.find=t,n.expr=t.selectors,n.expr[":"]=n.expr.pseudos,n.uniqueSort=n.unique=t.uniqueSort,n.text=t.getText,n.isXMLDoc=t.isXML,n.contains=t.contains;var u=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&n(a).is(c))break;d.push(a)}return d},v=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},w=n.expr.match.needsContext,x=/^<([\w-]+)\s*\/?>(?:<\/\1>|)$/,y=/^.[^:#\[\.,]*$/;function z(a,b,c){if(n.isFunction(b))return n.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return n.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(y.test(b))return n.filter(b,a,c);b=n.filter(b,a)}return n.grep(a,function(a){return n.inArray(a,b)>-1!==c})}n.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?n.find.matchesSelector(d,a)?[d]:[]:n.find.matches(a,n.grep(b,function(a){return 1===a.nodeType}))},n.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(n(a).filter(function(){for(b=0;e>b;b++)if(n.contains(d[b],this))return!0}));for(b=0;e>b;b++)n.find(a,d[b],c);return c=this.pushStack(e>1?n.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(z(this,a||[],!1))},not:function(a){return this.pushStack(z(this,a||[],!0))},is:function(a){return!!z(this,"string"==typeof a&&w.test(a)?n(a):a||[],!1).length}});var A,B=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,C=n.fn.init=function(a,b,c){var e,f;if(!a)return this;if(c=c||A,"string"==typeof a){if(e="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:B.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof n?b[0]:b,n.merge(this,n.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),x.test(e[1])&&n.isPlainObject(b))for(e in b)n.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}if(f=d.getElementById(e[2]),f&&f.parentNode){if(f.id!==e[2])return A.find(a);this.length=1,this[0]=f}return this.context=d,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):n.isFunction(a)?"undefined"!=typeof c.ready?c.ready(a):a(n):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),n.makeArray(a,this))};C.prototype=n.fn,A=n(d);var D=/^(?:parents|prev(?:Until|All))/,E={children:!0,contents:!0,next:!0,prev:!0};n.fn.extend({has:function(a){var b,c=n(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(n.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=w.test(a)||"string"!=typeof a?n(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&n.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?n.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?n.inArray(this[0],n(a)):n.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(n.uniqueSort(n.merge(this.get(),n(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function F(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}n.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return u(a,"parentNode")},parentsUntil:function(a,b,c){return u(a,"parentNode",c)},next:function(a){return F(a,"nextSibling")},prev:function(a){return F(a,"previousSibling")},nextAll:function(a){return u(a,"nextSibling")},prevAll:function(a){return u(a,"previousSibling")},nextUntil:function(a,b,c){return u(a,"nextSibling",c)},prevUntil:function(a,b,c){return u(a,"previousSibling",c)},siblings:function(a){return v((a.parentNode||{}).firstChild,a)},children:function(a){return v(a.firstChild)},contents:function(a){return n.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:n.merge([],a.childNodes)}},function(a,b){n.fn[a]=function(c,d){var e=n.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=n.filter(d,e)),this.length>1&&(E[a]||(e=n.uniqueSort(e)),D.test(a)&&(e=e.reverse())),this.pushStack(e)}});var G=/\S+/g;function H(a){var b={};return n.each(a.match(G)||[],function(a,c){b[c]=!0}),b}n.Callbacks=function(a){a="string"==typeof a?H(a):n.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h-1)f.splice(c,1),h>=c&&h--}),this},has:function(a){return a?n.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=!0,c||j.disable(),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j},n.extend({Deferred:function(a){var b=[["resolve","done",n.Callbacks("once memory"),"resolved"],["reject","fail",n.Callbacks("once memory"),"rejected"],["notify","progress",n.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return n.Deferred(function(c){n.each(b,function(b,f){var g=n.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&n.isFunction(a.promise)?a.promise().progress(c.notify).done(c.resolve).fail(c.reject):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?n.extend(a,d):d}},e={};return d.pipe=d.then,n.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=e.call(arguments),d=c.length,f=1!==d||a&&n.isFunction(a.promise)?d:0,g=1===f?a:n.Deferred(),h=function(a,b,c){return function(d){b[a]=this,c[a]=arguments.length>1?e.call(arguments):d,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(d>1)for(i=new Array(d),j=new Array(d),k=new Array(d);d>b;b++)c[b]&&n.isFunction(c[b].promise)?c[b].promise().progress(h(b,j,i)).done(h(b,k,c)).fail(g.reject):--f;return f||g.resolveWith(k,c),g.promise()}});var I;n.fn.ready=function(a){return n.ready.promise().done(a),this},n.extend({isReady:!1,readyWait:1,holdReady:function(a){a?n.readyWait++:n.ready(!0)},ready:function(a){(a===!0?--n.readyWait:n.isReady)||(n.isReady=!0,a!==!0&&--n.readyWait>0||(I.resolveWith(d,[n]),n.fn.triggerHandler&&(n(d).triggerHandler("ready"),n(d).off("ready"))))}});function J(){d.addEventListener?(d.removeEventListener("DOMContentLoaded",K),a.removeEventListener("load",K)):(d.detachEvent("onreadystatechange",K),a.detachEvent("onload",K))}function K(){(d.addEventListener||"load"===a.event.type||"complete"===d.readyState)&&(J(),n.ready())}n.ready.promise=function(b){if(!I)if(I=n.Deferred(),"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll)a.setTimeout(n.ready);else if(d.addEventListener)d.addEventListener("DOMContentLoaded",K),a.addEventListener("load",K);else{d.attachEvent("onreadystatechange",K),a.attachEvent("onload",K);var c=!1;try{c=null==a.frameElement&&d.documentElement}catch(e){}c&&c.doScroll&&!function f(){if(!n.isReady){try{c.doScroll("left")}catch(b){return a.setTimeout(f,50)}J(),n.ready()}}()}return I.promise(b)},n.ready.promise();var L;for(L in n(l))break;l.ownFirst="0"===L,l.inlineBlockNeedsLayout=!1,n(function(){var a,b,c,e;c=d.getElementsByTagName("body")[0],c&&c.style&&(b=d.createElement("div"),e=d.createElement("div"),e.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(e).appendChild(b),"undefined"!=typeof b.style.zoom&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",l.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(e))}),function(){var a=d.createElement("div");l.deleteExpando=!0;try{delete a.test}catch(b){l.deleteExpando=!1}a=null}();var M=function(a){var b=n.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b},N=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,O=/([A-Z])/g;function P(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(O,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:N.test(c)?n.parseJSON(c):c}catch(e){}n.data(a,b,c)}else c=void 0;
-}return c}function Q(a){var b;for(b in a)if(("data"!==b||!n.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function R(a,b,d,e){if(M(a)){var f,g,h=n.expando,i=a.nodeType,j=i?n.cache:a,k=i?a[h]:a[h]&&h;if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||n.guid++:h),j[k]||(j[k]=i?{}:{toJSON:n.noop}),"object"!=typeof b&&"function"!=typeof b||(e?j[k]=n.extend(j[k],b):j[k].data=n.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[n.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[n.camelCase(b)])):f=g,f}}function S(a,b,c){if(M(a)){var d,e,f=a.nodeType,g=f?n.cache:a,h=f?a[n.expando]:n.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){n.isArray(b)?b=b.concat(n.map(b,n.camelCase)):b in d?b=[b]:(b=n.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!Q(d):!n.isEmptyObject(d))return}(c||(delete g[h].data,Q(g[h])))&&(f?n.cleanData([a],!0):l.deleteExpando||g!=g.window?delete g[h]:g[h]=void 0)}}}n.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?n.cache[a[n.expando]]:a[n.expando],!!a&&!Q(a)},data:function(a,b,c){return R(a,b,c)},removeData:function(a,b){return S(a,b)},_data:function(a,b,c){return R(a,b,c,!0)},_removeData:function(a,b){return S(a,b,!0)}}),n.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=n.data(f),1===f.nodeType&&!n._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=n.camelCase(d.slice(5)),P(f,d,e[d])));n._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){n.data(this,a)}):arguments.length>1?this.each(function(){n.data(this,a,b)}):f?P(f,a,n.data(f,a)):void 0},removeData:function(a){return this.each(function(){n.removeData(this,a)})}}),n.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=n._data(a,b),c&&(!d||n.isArray(c)?d=n._data(a,b,n.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=n.queue(a,b),d=c.length,e=c.shift(),f=n._queueHooks(a,b),g=function(){n.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return n._data(a,c)||n._data(a,c,{empty:n.Callbacks("once memory").add(function(){n._removeData(a,b+"queue"),n._removeData(a,c)})})}}),n.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},Z=/^(?:checkbox|radio)$/i,$=/<([\w:-]+)/,_=/^$|\/(?:java|ecma)script/i,aa=/^\s+/,ba="abbr|article|aside|audio|bdi|canvas|data|datalist|details|dialog|figcaption|figure|footer|header|hgroup|main|mark|meter|nav|output|picture|progress|section|summary|template|time|video";function ca(a){var b=ba.split("|"),c=a.createDocumentFragment();if(c.createElement)while(b.length)c.createElement(b.pop());return c}!function(){var a=d.createElement("div"),b=d.createDocumentFragment(),c=d.createElement("input");a.innerHTML="
This document describes a typical use of the antaresRead package.
-
This package has been designed to read the results of an Antares simulation in an easy and convivial way. It can of course read any output files of a simulation at any desired time step, read synthetic results or detailed Monte Carlo scenarios but it can also add input time series to the results and perform some basic treatments like removing virtual areas.
-
-
Installation
-
-
The antaresRead package depends on the packages data.table, plyr and lubridate. If you have not already got them you can install them with the following command:
Then you can start using the package. The first function to use is setSimulationPath.
-
This function needs to be called at least once during each R session. It stores important informations that are used by most of the functions of the package. While it has not been run, these functions will not work.
-
Without any argument, setSimulationPath asks interactively to choose a directory containing an antares study. If the study contains multiple simulation results, it will also asks the user to choose one of them. This function stores the path to the output and reads some useful information about the simulation: type of output available, list of areas, links and clusters in the simulation, variables present in the output files, etc.
-
setSimulationPath can also be used in a non-interactive way with one of these syntaxes:
-
-# Specify full path
-setSimulationPath("study_path/output/simulation_name")
-
-# Specify the name of the simulation
-setSimulationPath("study_path", simulation_name)
-
-# Select a simulation by order
-setSimulationPath("study_path", 1)# first simulation
-
-# Select a simulation by reverse order
-setSimulationPath("study_path", -1)# last simulation
-
-# It is possible to store in a variable the result of the function
-opts<-setSimulationPath("study_path", 1)
-
The function returns an object containing informations about the selected simulation. You can store this object in a variable for later use but this is not necessary because at any moment you can retrieve these informations.
-
-
-
Reading time series
-
-
Once setSimulationPath has been run, you can start reading data. Function readAntares is there for that !
-
readAntares is the main function of the package. It is used to read every possible time series and it performs a few treatments on them to make your life easier. The result of the function will have the simplest structure possible: either a simple table or a list of tables if you asks data for differents elements (for instance links and areas)
-
It has a huge number of parameters to control exactly what you get, but all of them are optional. Without any argument the function will still works and it will read the synthetic results for all the areas. But you can import other kind of output. here are some examples:
-
-# Synthetic results for all links
-readAntares(links="all")
-
-#Synthetic results for all clusters
-readAntares(clusters="all")
-
-# Areas and links at the same time
-readAntares(areas="all", links="all")
-
-# Select only a few columns.
-readAntares(select =c("OV. COST", "OP. COST", "LOAD"))
-
You can also choose what elements to import and what level of details you want. For instance, the following command reads the first 10 Monte-Carlo scenarii data at monthly time step for the areas named “area1”, “area2” and “area3”.
Finally many arguments of readAntares can be used to add input time series to the object returned by the function. For instance, misc=TRUE will add columns containing miscelaneous productions for the imported areas.
-
-
-
Manipulating data
-
-
readAntares returns either a single table or a list of tables depending on the query of the user. More precisely the tables are data.table objects. It is then possible to use the powerful syntax offered by the package data.table.
For instance, areas[area == "08_fr", .(timeId, LOAD)] will return a table containing columns timeId and LOAD for the area names “08_fr”. In the select statement, it is also possible to calculate new columns. For instance, one can compute the net load like this:
readAntares can import almost everything but not everything because some data is not time series. Other functions exist to read this specific data: readBindingConstraints to read binding constraints, readClusterDesc to read cluster characteristics and readLayout to get the coordinates of the areas in the user interface of Antares.
-
Some parameters in readAntares and other functions wait for vectors of area names or link names. On large projects with lots of areas. It may be painful to specify by hand a long list of areas or links. Hopefully, the functions getAreasand getLinks can be used to select or exclude areas using regular expressions. For instance, let us assume that the name of all areas located in France start with the characters“fr”, then the following command returns the list of all french areas:
Vargas T, ZAWAM J, Guillem F, Thieurmel B, Robert T (2023).
-antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation.
-R package version 2.6.0, https://github.com/rte-antares-rpackage/antaresRead.
-
-
@Manual{,
- title = {antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation},
- author = {Tatiana Vargas and Jalal-Edine ZAWAM and Francois Guillem and Benoit Thieurmel and Titouan Robert},
- year = {2023},
- note = {R package version 2.6.0},
- url = {https://github.com/rte-antares-rpackage/antaresRead},
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css
deleted file mode 100644
index 5a859415..00000000
--- a/docs/bootstrap-toc.css
+++ /dev/null
@@ -1,60 +0,0 @@
-/*!
- * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)
- * Copyright 2015 Aidan Feldman
- * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */
-
-/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */
-
-/* All levels of nav */
-nav[data-toggle='toc'] .nav > li > a {
- display: block;
- padding: 4px 20px;
- font-size: 13px;
- font-weight: 500;
- color: #767676;
-}
-nav[data-toggle='toc'] .nav > li > a:hover,
-nav[data-toggle='toc'] .nav > li > a:focus {
- padding-left: 19px;
- color: #563d7c;
- text-decoration: none;
- background-color: transparent;
- border-left: 1px solid #563d7c;
-}
-nav[data-toggle='toc'] .nav > .active > a,
-nav[data-toggle='toc'] .nav > .active:hover > a,
-nav[data-toggle='toc'] .nav > .active:focus > a {
- padding-left: 18px;
- font-weight: bold;
- color: #563d7c;
- background-color: transparent;
- border-left: 2px solid #563d7c;
-}
-
-/* Nav: second level (shown on .active) */
-nav[data-toggle='toc'] .nav .nav {
- display: none; /* Hide by default, but at >768px, show it */
- padding-bottom: 10px;
-}
-nav[data-toggle='toc'] .nav .nav > li > a {
- padding-top: 1px;
- padding-bottom: 1px;
- padding-left: 30px;
- font-size: 12px;
- font-weight: normal;
-}
-nav[data-toggle='toc'] .nav .nav > li > a:hover,
-nav[data-toggle='toc'] .nav .nav > li > a:focus {
- padding-left: 29px;
-}
-nav[data-toggle='toc'] .nav .nav > .active > a,
-nav[data-toggle='toc'] .nav .nav > .active:hover > a,
-nav[data-toggle='toc'] .nav .nav > .active:focus > a {
- padding-left: 28px;
- font-weight: 500;
-}
-
-/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */
-nav[data-toggle='toc'] .nav > .active > ul {
- display: block;
-}
diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js
deleted file mode 100644
index 1cdd573b..00000000
--- a/docs/bootstrap-toc.js
+++ /dev/null
@@ -1,159 +0,0 @@
-/*!
- * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)
- * Copyright 2015 Aidan Feldman
- * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */
-(function() {
- 'use strict';
-
- window.Toc = {
- helpers: {
- // return all matching elements in the set, or their descendants
- findOrFilter: function($el, selector) {
- // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/
- // http://stackoverflow.com/a/12731439/358804
- var $descendants = $el.find(selector);
- return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])');
- },
-
- generateUniqueIdBase: function(el) {
- var text = $(el).text();
- var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');
- return anchor || el.tagName.toLowerCase();
- },
-
- generateUniqueId: function(el) {
- var anchorBase = this.generateUniqueIdBase(el);
- for (var i = 0; ; i++) {
- var anchor = anchorBase;
- if (i > 0) {
- // add suffix
- anchor += '-' + i;
- }
- // check if ID already exists
- if (!document.getElementById(anchor)) {
- return anchor;
- }
- }
- },
-
- generateAnchor: function(el) {
- if (el.id) {
- return el.id;
- } else {
- var anchor = this.generateUniqueId(el);
- el.id = anchor;
- return anchor;
- }
- },
-
- createNavList: function() {
- return $('
');
- },
-
- createChildNavList: function($parent) {
- var $childList = this.createNavList();
- $parent.append($childList);
- return $childList;
- },
-
- generateNavEl: function(anchor, text) {
- var $a = $('');
- $a.attr('href', '#' + anchor);
- $a.text(text);
- var $li = $('');
- $li.append($a);
- return $li;
- },
-
- generateNavItem: function(headingEl) {
- var anchor = this.generateAnchor(headingEl);
- var $heading = $(headingEl);
- var text = $heading.data('toc-text') || $heading.text();
- return this.generateNavEl(anchor, text);
- },
-
- // Find the first heading level (`
`, then `
`, etc.) that has more than one element. Defaults to 1 (for `
The parameter simulation can be the name of a simulation, the name of the folder containing the simulation results, or the index of the simulation. 1 corresponds to the oldest simulation, -1 to the newest one, 0 to the inputs.
-
-
-
Read data from a simulation
-
-
Most data from a simulation can be imported in the R session with function readAntares(). It has many parameters that control what data is imported. Here are a few examples:
-
-# Read synthetic results of all areas of a study with hourly time step.
-areaData<-readAntares(areas ="all")
-
-# Same but with a daily time step:
-areaData<-readAntares(areas ="all", timeStep ="daily")
-
-# Read all Monte Carlo scenarios for a given area.
-myArea<-readAntares(areas ="my_area", mcYears ="all")
-
-# Same but add miscelaneous production time series to the result
-myArea<-readAntares(areas ="my_area", mcYears ="all", misc =TRUE)
-
-# Read only columns "LOAD" and "MRG. PRICE"
-areaData<-readAntares(areas ="all", select =c("LOAD", "MRG. PRICE"))
-
Functions getAreas and getLinks are helpful to create a selection of areas or links of interest. Here are a few examples:
-
-# select areas containing "fr"
-myareas<-getAreas("fr")
-
-# Same but remove areas containing "hvdc"
-myareas<-getAreas("fr", exclude ="hvdc")
-
-# Get the links that connect two of the previous areas
-mylinks<-getLinks(myareas, internalOnly =FALSE)
-
-# Get the results for these areas and links
-mydata<-readAntares(areas =myareas, links =mylinks)
-
-
-
Work with the imported data
-
-
When only one type of elements is imported (only areas or only links, etc.) readAntares() read antares returns a data.table with some extra attributes. A data.table is a table with some enhanced capacities offered by package data.table. In particular it provides a special syntax to manipulate its content:
-# Select lines based on some criteria
-mydata[area=="fr"&month=="JUL"]
-
-# Select columns, and compute new ones
-mydata[, .(area, month, load2 =LOAD^2)]
-
-# Aggregate data by some variables
-mydata[, .(total =sum(LOAD)), by =.(month)]
-
-# All three operations can be done with a single line of code
-mydata[area=="fr", .(total =sum(LOAD)), by =.(month)]
-
-help(package ="data.table")
-
If you are not familiar with package data.table, you should have a look at the documentation and especially at the vignettes of the package:
Contributions to the library are welcome and can be submitted in the form of pull requests to this repository.
-
The folder test_case contains a test Antares study used to run automatic tests. If you modifies it, you need to run the following command to include the modifications in the tests:
Antares is a powerful software developed by RTE to simulate and study electric power systems (more information about Antares here : https://antares-simulator.org/).
-
ANTARES is now an open-source project (since 2018), you can download the sources here if you want to use this package.
This Source Code is subject to the terms of the GNU General Public License, version 2 or any higher version. If a copy of the GPL-v2 was not distributed with this file, You can obtain one at https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html.
Major upgrade to aggregateResult() and parAggregateMCall() : * Faster & memory efficient * Support for Antares studies up to v8.3 (v8.4 experimental) * Dynamic timestep detection * Creation of grid folder * Recycling of original mc-all data
-
-
-
antaresRead 2.3.2
-
NEW FEATURES:
-
added “profit by cluster” when reading cluster data.
-
BUGFIXES:
-
Fix for 404 error when some output is missing in API mode(#188).
-
-
-
antaresRead 2.3.1
-
BUGFIXES:
-
readAntares : fix memory problems for linkCapacity = TRUE (>v8.2)
“readAntares()” : prevent bug dealing with integer64
-
“writeAntaresH5()” was not working anymore due to a new version of rhdf5 (h5close() does not work anymore). (#110)
-
-
-
antaresRead 2.1.2 (2018-06-01)
-
BUGFIXES:
-
getLinks() was sending an error when there are no links in the study.
-
-
antaresRead 2.1.1 (2018-04-28)
-
BUGFIXES:
-
readInputTS() was sending bad values for hydroStorage. (#58)
-
changeTimeStep() will print a warning if the user want to aggregate data. (#54)
-
readAntares() will print warnings when a user want to aggregate mustRun data (#54)
-
-
-
antaresRead 2.1.0 (2018-02-23)
-
NEW FEATURES:
-
readInputTS() has a new parameter “thermalOutages” that permits to read thermal outages characteristics
-
Call removeVirtualAreas several times in writeAntaresH5()
-
BUGFIXES:
-
Correction of some bugs in removeVirtualAreas when there is several virtual nodes of production and storageFlexibility
-
Correction of some bugs due to the new lubridate version
-
-
-
antaresRead 2.0.2 (2017-11-21)
-
BUGFIXES:
-
Some tests failed in some platforms on CRAN.
-
-
antaresRead 2.0.1 (2017-11-14)
-
BUGFIXES:
-
readLayout() was not taking a list of simOptions.
-
-
antaresRead 2.0.0 (2017-11-03)
-
NEW FEATURES:
-
New function “writeAntaresH5()” convert ANTARES outputs to h5 files.
-
The path parameter of “setSimulationPath()” can be a h5 file.
-
New function “isH5Opts()” test if the value returned by setSimulationPath() is referring to an h5 file.
-
New function “readOptimCriteria()” read the value of the criteria optimized by ANTARES.
-
New function “setRam()” specify RAM limit (in Go) of the value returned by readAntares, initially it is 10Go.
-
New vignette “antaresH5” is available.
-
BUGFIXES:
-
removeVirtualAreas() was not moving clusters from virtual production area to the real area.
-
antaresRead() sometimes returned a antaresDataList with element “thermalModulation”. (#51)
-
-
-
antaresRead 1.1.4 (2017-07-07)
-
BUGFIXES:
-
setSimulation() was crashing with antares v6.0 because of the folder “maps”. (#49)
-
-
antaresRead 1.1.3 (2017-05-30)
-
BUGFIXES:
-
readInputTS was crashing when trying to import cluster data and some clusters were disabled.
-
-
antaresRead 1.1.2 (2017-04-18)
-
BUGFIXES:
-
Fixed an issue that caused compilation to crash on mac OS X
-
-
antaresRead 1.1.0 (2017-03-31)
-
NEW FEATURES:
-
The ‘select’ parameter of readAntares() has been improved. It now accepts new keywords “areas”, “links”, “clusters”, “districts” to indicate which type of data to read,“mcYears” to import detailed results, “misc”, “mustRun”, etc. to import the corresponding input data.
-
A new function setAlias() has been added. It permits to packages developers to define new aliases to use in the ‘select’ parameter of readAntares() in order to help their users to import the required data.
-
readBindingConstraints() has been improved and returns an object of class ‘bindingConstraints’ which is a named list where each element has the same structure.
-
A summary method has been added for objects of class ‘bindingConstraints’. It is useful to quickly look at the binding contraints defined in a study.
-
readAntares(mustRun = TRUE) now adds a new column “thermalPmin”. It is similar to mustRunTotal, except it also takes into account the minimum stable power of the cluster units.
-
BUGFIXES:
-
Columns ‘pumpingCapacity’ and ‘storageCapacity’ created by removeVirtualAreas() were reversed.
-
setSimulationPath() was sometimes setting a start data that was not consistent with parameters “1st january” and “leap year”.
-
setSimulationPath() was not working if synthetic results and the first Monte-Carlo scenario were not saved in a given Antares simulation.
-
readAntares(clusters = “all”) was not working in some situations.
-
-
-
antaresRead 1.0.0 (2017-02-23)
-
BUGFIXES:
-
In some specific situations, date columns could be filled with NA values. (#26)
-
Many small problems that were detected by R CMD CHECK.
-
-
-
antaresRead 0.15 (2017-01-25)
-
BREAKING CHANGES:
-
Parameter “synthesis” has been removed from readAntares. The new behavior is now to import synthetic results when “mcYears” is NULL and to import detailed results when “mcYears” is set.
NEW FEATURES:
-
New function “getIdCols()” returns the Id columns of an antaresDataTable object.
-
New method “subset()” for antaresDataList objects permits to quickly extract the data for a given area or a given Monte-Carlo scenario.
-
BUGFIXES:
-
In “input” mode, getLinks() could return links that did not exist anymore.
-
removeVirtualAreas was requiring some data that was not necesary. It should be OK now.
-
setSimulationPath() was crashing when one wanted to read the input data of a study before having run any simulation.
-
Variable “timeId” is now always numeric. Before it was numeric except for annual data where it could be character or factor.
-
-
-
antaresRead 0.14 (2016-11-14)
-
NEW FEATURES:
-
readAntares() has been significantly improved. Depending on the query, the time needed to import data is decreased by 20% up to 95%. In particular, importing data for clusters is now 20 times faster than before. Moreover, the progress bar is now more precise.
-
removeVirtualAreas() has a new parameter “newCols” that permits to choose whether to create new columns containing the production of the virtual areas or to update the existing ones.
-
removeVirtualAreas() now also removes virtual links from the data. Before it was removing virtual areas but keeping the virtual links.
-
If the transmission capacity of the links is present in the data, removeVirtualAreas() now creates two new columns containing the capacity of pumping and storage of areas. These columns are used to compute upward and downward margins.
-
New functions as.antaresDataTable and as.antaresDataList have been added to convert compatible objects to these classes.
-
-
-
antaresRead 0.13 (2016-10-06)
-
BREAKING CHANGES:
-
add a file LICENSE and copyright to sources files
-
-
antaresRead 0.12 (2016-08-17)
-
BREAKING CHANGES:
-
The object returned by ‘setSimulationPath’ and ‘simOptions’ has been modified. In particular, paths have been renamed to make their utility clearer. Moreover a new element named ‘linksDef’ contains a table with the specification of each link of the study.
NEW FEATURES:
-
getLinks() can now return a table with the specification of the links, thanks to two new parameters “namesOnly” and “withDirection”
-
It is now possible to import several times the same Monte-Carlo scenario. This can be useful for performance test or to use bootstrap methods.
-
BUGFIXES:
-
readClusterDesc was not working in input mode.
-
Sometimes setSimulationPath changed working directory.
-
Solved some performance issues in readAntares() and removeVirtualAreas().
-
-
-
antaresRead 0.11 (2016-08-01)
-
BREAKING CHANGES:
-
The parameters of ‘getLinks’ have been modified because they were unclear. Now user has to to explicitly specify areas to include and/or exclude.
BUGFIXES:
-
setSimulationPath was crashing if parameter ‘horizon’ was not set in Antares.
-
changeTimeStep sometimes generated NA values because of integer overflow.
-
-
-
antaresRead 0.10 (2016-07-18)
-
BREAKING CHANGES: * Variable mustRunModuction has been renamed minGenModulation for consistency with Antares * Similarly in the object returned by setSimulationPath and simOptions, “setList” has been renamed “districtList”
-
NEW FEATURES: * Now, when one filters, add, remove or update columns of an object of class ‘antaresDataTable’, the result is still of class ‘antaresDataTable’.
-
-
-
antaresRead 0.9.1 (2016-07-05)
-
BUGFIXES:
-
readAntares was incorrectly setting attributes of its ouput. This resulted in errors when using functions of the antaresProcessing package.
-
-
antaresRead 0.9 (2016-07-04)
-
BREAKING CHANGES:
-
The columns returned by readAntares when ‘hydroStorageMaxPower = TRUE’ have been renamed.
NEW FEATURES:
-
readAntares has a new parameter “thermalModulation” to import modulation time series.
-
New aliases have been added. One can inspect them with “showAliases()”.
-
-
-
antaresRead 0.8 (2016-06-20)
-
NEW FEATURES:
-
setSimulationPath nows reads costs of unsupplied et spilled energy.
-
ReadLayout computes coordinates for districts and link between them.
-
getAreas has a new parameter “district” to get areas in a set of districts.
-
getLinks has new parameter “areas” to get links connected to a set of areas.
-
BUGFIXES:
-
Small bug fixes that avoid useless warning messages/
-
-
antaresRead 0.7 (2016-06-07)
-
BREAKING CHANGES:
-
The package has been renamed “antaresRead”.
NEW FEATURES:
-
changeTimeStep accepts two new functions : min and max.
-
readAntares now computes the number of available units.
-
BUGFIXES:
-
setSimulationPath was crashing if parameter “horizon” was not set in Antares.
-
setSimulationPath throws a warning when two simulations have same name and it uses the most recent one.
-
In presence of hubs and production nodes, removeVirtualAreas treated production nodes two times.
-
Column “month” was sometimes numeric and other times character.
-
setSimulationPath was not recognising option “apply-filter = add-all” when retrieving district definition.
-
-
-
antaresRead 0.6 (2016-05-27)
-
NEW FEATURES:
-
readAntares and readInputTS always add time columns (time, day, month, hour). changeTimeStep now keeps them if they are present.
BUGFIXES:
-
readAntares may not work when some MC years were not exported by Antares.
-
The construction of the weeks was wrong when a year did not start on january.
-
The import of inputs was wrong when the study was not conducted on a whole year but on a smaller period.
-
In removeVirtualNodes, option “reassignCosts” was not working correctly.
-
-
-
antaresRead 0.5 (2016-05-11)
-
BREAKING CHANGES:
-
To be consistent with Antares, ‘node’ has been replaced by ‘area’ everywhere in the package.
-
Column ‘MWh’ is now named ‘production’ when reading clusters output.
-
NEW FEATURES:
-
new function ‘readInputTS’ to read input time series (without output time series)
-
‘setSimulationPath’ now accepts two new values for the argument “simulation”: 0 and “input”. These values indicate that the user is not interested by the results of any simulation and only wants to read input data.
-
changeTimeStep now accepts for parameter ‘fun’ a vector of function names that indicate how to aggregate/disagregate each column.
-
getAreas has a new argument “withClustersOnly” to select areas containing clusters
-
readAntares can now also add input time series to districts like it does for areas
-
BUGFIXES:
-
‘copyToClipboard’ was copying the word “txt” instead of copying data
-
‘removeVirtualNodes’ was not creating some columns for production virtual nodes.
-
The option ‘mustRun’ in readAntares was not functionning correctly
-
-
-
antaresRead 0.4 (2016-04-29)
-
BREAKING CHANGES:
-
The parameters and the output of “readAntares” have been modified. The output has now only three components: nodes, links and clusters. If the user asks other information like hydro storage or links capacities, they are added to the corresponding component. The corresponding parameters now expect TRUE/ FALSE instead of a vector of node or link names.
-
“getLinks” has now same parameters and behavior than “getNodes”
-
Parameter “trace” has been removed in “setSimulationPath”.
-
NEW FEATURES:
-
“readAntares” has a new argument “mustRun”
-
“removeVirtualNodes” has been finalised
-
New function “simOptions” to get either global simulation options or simulation options used by “readAntares” to create a given object
-
New alias “nosum” to remove “min”, “max”, and “std” columns when “synthesis=TRUE” in “readAntares”
-
“setSimulationPath” has a new argument “simulation” to choose a simulation by name or by order inside an antares project
-
New function “getDistricts”
-
New function “copyToClipboard”
-
Added package vignette
-
-
-
antaresRead 0.3 (2016-04-14)
-
NEW FEATURES:
-
“readAntares” can now read hydro storage, hydro storage maximum power, reserve and links capacity
-
New function “readAntaresNodes”: read all the desired data for a set of nodes
-
New function “readBindingConstraints”
-
New function “changeTimeStep”: change the timestep of an “antaresOutput” object or any table containing a variable timeId
-
New function “getNodes”: select and filter nodes of an antares study
-
“extractDataList” has been improved for better compatibility with PPSE scripts
-
Improved documentation
-
New function removeVirtualNodes (still experimental)
-
Added this NEWS file :)
-
-
-
antaresRead 0.2 (2016-04-05)
-
BREAKING CHANGES:
-
“readOutput” has been renamed “readAntares”
NEW FEATURES:
-
“readAntares” can now read thermal availabilities
-
“setSimulationPath” now reads simulation parameters
-
“setSimulationPath” now accepts path to a study and eventually asks the user to choose an output
-
Nodes and sets are now separated in “readAntares” and “setSimulationPath”
-
aliases for groups of variables in parameter “select” of “readAntares”
Antares simulation options or a list with an host = slot.
-
-
-
endpoint
-
API endpoint to interrogate, it will be added after default_endpoint.
-Can be a full URL (by wrapping ìn I()), in that case default_endpoint is ignored.
-
-
-
...
-
Additional arguments passed to API method.
-
-
-
default_endpoint
-
Default endpoint to use.
-
-
-
-
Value
-
-
-
Response from the API.
-
-
-
-
Examples
-
if(FALSE){
-
-# List studies with local API
-api_get(
- opts =list(host ="http://0.0.0.0:8080"),
- endpoint =NULL
-)
-
-}
-
This function converts a list of tables or table into an
-antaresDataList object.
-
An antaresDataList is a list of tables of classantaresDataTable.
-It also has attributes that store the time step, the type of data and the
-simulation options.
-
-
-
-
as.antaresDataList(x, ...)
-
-# S3 method for antaresDataTable
-as.antaresDataList(x, name =NULL, ...)
-
-# S3 method for data.frame
-as.antaresDataList(
-x,
-synthesis,
-timeStep,
-type,
- opts =simOptions(),
- name =type,
-...
-)
-
-
-
-
Arguments
-
x
-
Data.frame or data.table to convert to a an antaresDataTable.
-
-
-
...
-
Arguments to be passed to methods.
-
-
-
name
-
name of the table in the final object. If NULL, the type of the data
-is used.
-
-
-
synthesis
-
Does the table contain synthetic results ?
-
-
-
timeStep
-
Time step of the data. One of "hourly", "daily", "weekly", "monthly" or "annual".
-
-
-
type
-
type of data: for instance "areas", "links", "clusters", etc.
This function changes the timestep of a table or an antaresData object
-and performs the required aggregation or desaggregation. We can specify
-(des)aggregate functions by columns, see the param fun.
-
-
-
-
changeTimeStep(x, newTimeStep, oldTimeStep, fun ="sum", opts =simOptions())
-
-
-
-
Arguments
-
x
-
data.table with a column "timeId" or an object of class "antaresDataList"
-
-
-
newTimeStep
-
Desired time step.The possible values are hourly, daily, weekly,
-monthly and annual.
-
-
-
oldTimeStep
-
Current time step of the data. This argument is optional for an object of
-class antaresData because the time step of the data is stored inside
-the object
-
-
-
fun
-
Character vector with one element per column to (des)aggregate indicating
-the function to use ("sum", "mean", "min" or "max") for this column. It can
-be a single element, in that case the same function is applied to every
-columns.
-
-
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
-
Value
-
-
-
Either a data.table or an object of class "antaresDataList" depending on the
-class of x
character or numeric indicating which element to copy to clipboard (areas,
-links, clusters or districts)
-
-
-
-
Value
-
-
-
The function does not return anything. It is only used to interact with the
-clipboard
-
-
-
Note
-
The function is useful only for small data objects: for a table,
-only the 50000 rows are copied to clipboard. If the table to copy
-is longer, either use filters to reduce the number of rows or write the
-table in text file with write.table
-
-
-
-
Examples
-
# This only works on Windows systems
-if(FALSE){
-x<-data.frame(a =sample(10), b =sample(10))
-
-copyToClipboard(x)
-
-# Try to open excel and use CTRL + V to copy the data in a spreadsheet.
-}
-
-
This function converts an "readAntares" object in the data structure used
-by PPSE : instead of having one table for areas, one for links and one for
-clusters, the function creates a list with one element per area. Each element
-is a data.table containing the data about the area and one column per cluster
-of the area containing the production of this cluster.
-
-
-
-
extractDataList(x, areas =NULL)
-
-
-
-
Arguments
-
x
-
object of class "antaresData" or "antaresTable" created by the function
-readAntares
-
-
-
areas
-
character vector containing the name of areas to keep in the
-final object. If NULL, all areas are kept in the final object.
-
-
-
-
Value
-
-
-
a list of data.tables with one element per area. The list also
-contains an element named "areaList" containing the name of areas in the
-object and a table called "infos" that contains for each area the number
-of variables of different type (values, details, link).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/reference/figures/antares_simulator.png b/docs/reference/figures/antares_simulator.png
deleted file mode 100644
index 0115f089..00000000
Binary files a/docs/reference/figures/antares_simulator.png and /dev/null differ
diff --git a/docs/reference/figures/badge_api_no.svg b/docs/reference/figures/badge_api_no.svg
deleted file mode 100644
index 35501024..00000000
--- a/docs/reference/figures/badge_api_no.svg
+++ /dev/null
@@ -1,20 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/reference/figures/badge_api_ok.svg b/docs/reference/figures/badge_api_ok.svg
deleted file mode 100644
index a210e856..00000000
--- a/docs/reference/figures/badge_api_ok.svg
+++ /dev/null
@@ -1,20 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/reference/figures/h5_comparison.PNG b/docs/reference/figures/h5_comparison.PNG
deleted file mode 100644
index 34b2bf03..00000000
Binary files a/docs/reference/figures/h5_comparison.PNG and /dev/null differ
diff --git a/docs/reference/getAreas.html b/docs/reference/getAreas.html
deleted file mode 100644
index 6e4205a7..00000000
--- a/docs/reference/getAreas.html
+++ /dev/null
@@ -1,171 +0,0 @@
-
-Select and exclude areas — getAreas • antaresRead
-
-
-
getAreas and getDistricts are utility functions that builds
-list of areas or districts by using regular expressions to select and/or
-exclude areas/districts
Character vector. If regexpSelect is TRUE, this vector is
-interpreted as a list of regular expressions. Else it is interpreted as a
-list of area names. If NULL, all areas are selected
-
-
-
exclude
-
Character vector. If regexpExclude is TRUE, this vector is
-interpreted as a list of regular expressions and each area validating one
-of them is excluded. Else it is interpreted as list of area names to
-exclude. If NULL, not any area is excluded.
-
-
-
withClustersOnly
-
Should the function return only nodes containing clusters ?
-
-
-
regexpSelect
-
Is select a list of regular expressions ?
-
-
-
regexpExclude
-
Is exclude a list of regular expressions ?
-
-
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
ignore.case
-
Should the case be ignored when evaluating the regular
-expressions ?
-
-
-
districts
-
Names of districts. If this argument is not null, only areas belonging
-to the specified districts are returned.
-
-
-
-
Value
-
-
-
A character vector containing the name of the areas/districts satisfying the
-rules defined by the parameters.
Vector containing area names. It represents the set of areas we are interested
-in. If NULL, all areas of the study are used.
-
-
-
exclude
-
Vector containing area names. If not NULL, all links connected to
-one of these areas are omitted.
-
-
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
internalOnly
-
If TRUE, only links that connect two areas from parameter areas are returned.
-If not, the function also returns all the links that connect an area from the list with
-an area outside the list.
-
-
-
namesOnly
-
If TRUE, the function returns a vector with link names, else it
-returns a table containing the name, the origin and the destination of each
-selected link.
-
-
-
withDirection
-
Used only if namesOnly = FALSE. If FALSE, then the function
-returns a table with one line per link, containing the link name, the
-origin and the destination of the link. If TRUE, then it returns a
-table with columns area, link, to and direction
-which is equal is equal to
-1 if the link connects area to to and -1 if it connects
-to to area.
-The column area contains only areas that are compatible with parameters
-areas and exclude. Note that the same link can appear twice
-in the table with different directions.
-
-
-
withTransmission
-
Used only if namesOnly = FALSE. If TRUE, a column is added to indicate
-type of transmission capacities for links.
-
-
-
-
Value
-
-
-
If namesOnly = TRUE the function returns a vector containing link names
-
-
-
If namesOnly = FALSE and withDirection = FALSE, it returns a
-data.table with exactly one line per link and with three columns:
-
link
-
Link name
-
-
from
-
First area connected to the link
-
-
to
-
Second area connected to the link
-
-
-
If namesOnly = FALSE and withDirection = TRUE, it returns a
-data.table with one or two lines per link and with four columns:
-
area
-
Area name
-
-
link
-
Link name
-
-
to
-
Area connected to area by link
-
-
direction
-
1 if the link connects area to to else -1
-
-
-
-
-
Examples
-
if(FALSE){
-
-# Get all links of a study
-getLinks()
-
-# Get all links with their origins and destinations
-getLinks(namesOnly =FALSE)
-
-# Get all links connected to French areas (assuming their names contain "fr")
-getLinks(getAreas("fr"))
-
-# Same but with only links connecting two French areas
-getLinks(getAreas("fr"), internalOnly =TRUE)
-
-# Exclude links connecting real areas with pumped storage virtual areas
-# (assuming their names contain "psp")
-getLinks(getAreas("fr"), exclude =getAreas("psp"))
-
-}
-
-
readAntares is a swiss-army-knife function used to read almost every
-possible time series of an antares Project at any desired time resolution
-(hourly, daily, weekly, monthly or annual).
-
It was first designed to read
-output time series, but it can also read input time series. The input time
-series are processed by the function to fit the query of the user (timeStep,
-synthetic results or Monte-Carlo simulation, etc.). The few data that are not
-read by readAntares can generally by read with other functions of the
-package starting with "read" (readClusterDesc,
-readLayout, readBindingConstraints)
Vector containing the names of the areas to import. If
-NULL no area is imported. The special value "all" tells the
-function to import all areas. By default, the value is "all" when no other argument is enter and "NULL" when other arguments are enter.
-
-
-
links
-
Vector containing the name of links to import. If NULL no
-area is imported. The special value "all" tells the function to
-import all areas. Use function getLinks to import all links
-connected to some areas.
-
-
-
clusters
-
Vector containing the name of the areas for which you want to
-import results at thermal cluster level. If NULL no cluster is imported. The
-special value "all" tells the function to import thermal clusters from all
-areas.
-
-
-
districts
-
Vector containing the names of the districts to import. If NULL,
-no district is imported. The special value "all" tells the function to import all
-districts.
-
-
-
clustersRes
-
Vector containing the name of the areas for which you want to
-import results at renewable cluster level. If NULL no cluster is imported. The
-special value "all" tells the function to import renewable clusters from all
-areas.
-
-
-
bindingConstraints
-
Should binding constraints be imported (v8.4+)?
-
-
-
misc
-
Vector containing the name of the areas for which you want to
-import misc.
-
-
-
thermalAvailabilities
-
Should thermal availabilities of clusters be imported ? If TRUE, the column
-"thermalAvailability" is added to the result and a new column "availableUnits"
-containing the number of available units in a cluster is created.If synthesis is set to TRUE then
-"availableUnits" contain the mean of avaible units on all MC Years.
-
-
-
hydroStorage
-
Should hydro storage be imported ?
-
-
-
hydroStorageMaxPower
-
Should hydro storage maximum power be imported ?
-
-
-
reserve
-
Should reserve be imported ?
-
-
-
linkCapacity
-
Should link capacities be imported ?
-
-
-
mustRun
-
Should must run productions be added to the result? If TRUE,
-then four columns are added: mustRun contains the production of
-clusters that are in complete must run mode; mustRunPartial
-contains the partial must run production of clusters; mustRunTotal
-is the sum of the two previous columns. Finally thermalPmin is
-similar to mustRunTotal except it also takes into account the production
-induced by the minimum stable power of the units of a cluster. More
-precisely, for a given cluster and a given time step, it is equal to
-min(NODU x min.stable.power, mustRunTotal).
-
-
-
thermalModulation
-
Should thermal modulation time series be imported ? If TRUE, the
-columns "marginalCostModulation", "marketBidModulation", "capacityModulation"
-and "minGenModulation" are added to the cluster data.
-
-
-
select
-
Character vector containing the name of the columns to import. If this
-argument is NULL, all variables are imported. Special names
-"allAreas" and "allLinks" indicate to the function to import
-all variables for areas or for links. Since version 1.0, values "misc",
-"thermalAvailabilities", "hydroStorage", "hydroStorageMaxPower", "reserve",
-"linkCapacity", "mustRun", "thermalModulation" are also accepted and can
-replace the corresponding arguments. The list of available variables can be
-seen with the command simOptions()$variables. Id variables like
-area, link or timeId are automatically imported.
-Note that select is not taken into account when importing cluster
-data.
-
-
-
mcYears
-
Index of the Monte-Carlo years to import. If NULL, synthetic results
-are read, else the specified Monte-Carlo simulations are imported. The
-special value all tells the function to import all Monte-Carlo
-simulations.
-
-
-
timeStep
-
Resolution of the data to import: hourly (default), daily,
-weekly, monthly or annual.
-
-
-
mcWeights
-
Vector of weights to apply to the specified mcYears. If not NULL, the vector must
-be the same length as the vector provided in the mcYear parameter. The function
-readAntares will then return the weighted synthetic results for the specified years,
-with the specified weights.
-
-
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
parallel
-
Should the importation be parallelized ? (See details)
-
-
-
simplify
-
If TRUE and only one type of output is imported then a
-data.table is returned. If FALSE, the result will always be a list of class
-"antaresData".
-
-
-
showProgress
-
If TRUE the function displays information about the progress of the
-importation.
-
-
-
-
Value
-
-
-
If simplify = TRUE and only one type of output is imported
-then the result is a data.table.
-
-
-
Else an object of class "antaresDataList" is returned. It is a list of
-data.tables, each element representing one type of element (areas, links,
-clusters)
-
-
-
Details
-
If parameters areas, links, clusters and districts
-are all NULL, readAntares will read output for all areas.
-By default the function reads synthetic results if they are available.
-
readAntares is able to read input time series, but when they are not
-stored in output, these time series may have changed since a simulation has
-been run. In such a case the function will remind you this danger with a
-warning.
-
When individual Monte-Carlo simulations are read, the function may crash
-because of insufficient memory. In such a case, it is necessary to reduce
-size of the output. Different strategies are available depending on your
-objective:
-
Use a larger time step (parameter timeStep)
-
Filter the elements to import (parameters areas,links,
-clusters and districts)
-
Select only a few columns (parameter select)
-
read only a subset of Monte-Carlo simulations (parameter
-mcYears). For instance one can import a random sample of
-100 simulations with mcYears = sample(simOptions()$mcYears, 100)
-
-
-
Parallelization
-
-
-
-
If you import several elements of the same type (areas, links, clusters), you
-can use parallelized importation to improve performance. Setting the
-parameter parallel = TRUE is not enough to parallelize the
-importation, you also have to install the package
-foreach
-and a package that provides a parallel backend (for instance the package
-doParallel).
-
Before running the function with argument parallel=TRUE, you need to
-register your parallel backend. For instance, if you use package "doParallel"
-you need to use the function registerDoParallel once per
-session.
if(FALSE){
-# Import areas and links separately
-
-areas<-readAntares()# equivalent to readAntares(areas="all")
-links<-readAntares(links="all")
-
-# Import areas and links at same time
-
-output<-readAntares(areas ="all", links ="all")
-
-# Add input time series to the object returned by the function
-areas<-readAntares(areas ="all", misc =TRUE, reserve =TRUE)
-
-# Get all output for one area
-
-myArea<-sample(simOptions()$areaList, 1)
-myArea
-
-myAreaOutput<-readAntares(area =myArea,
- links =getLinks(myArea, regexpSelect=FALSE),
- clusters =myArea)
-
-# Or equivalently:
-myAreaOutput<-readAntaresAreas(myArea)
-
-# Use parameter "select" to read only some columns.
-
-areas<-readAntares(select =c("LOAD", "OV. COST"))
-
-# Aliases can be used to select frequent groups of columns. use showAliases()
-# to view a list of available aliases
-
-areas<-readAntares(select="economy")
-
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/reference/readAntaresAreas.html b/docs/reference/readAntaresAreas.html
deleted file mode 100644
index 4382be82..00000000
--- a/docs/reference/readAntaresAreas.html
+++ /dev/null
@@ -1,166 +0,0 @@
-
-Read output for a list of areas — readAntaresAreas • antaresRead
-
-
-
Vector containing area names. It represents the set of areas we are interested
-in. If NULL, all areas of the study are used.
-
-
-
links
-
should links connected to the areas be imported ?
-
-
-
clusters
-
should the thermal clusters of the areas be imported ?
-
-
-
clustersRes
-
should the renewable clusters of the areas be imported ?
-
-
-
internalOnly
-
If TRUE, only links that connect two areas from parameter areas are returned.
-If not, the function also returns all the links that connect an area from the list with
-an area outside the list.
-
-
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
...
-
Other arguments passed to the function readAntares
-
-
-
-
Value
-
-
-
If simplify = TRUE and only one type of output is imported
-then the result is a data.table.
-
-
-
Else an object of class "antaresData" is returned. It is a list of
-data.tables, each element representing one type of element (areas, links,
-clusters)
This function reads the binding constraints of an Antares project.
-
Be aware that binding constraints are read in the input files of a study. So
-they may have changed since a simulation has been run.
-
-
-
-
readBindingConstraints(opts =simOptions())
-
-# S3 method for bindingConstraints
-summary(object, ...)
-
-
-
-
Arguments
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
object
-
Object returned by readBindingConstraints
-
-
-
...
-
Unused
-
-
-
-
Value
-
-
-
readBindingConstraints returns an object of class bindingConstraints.
-It is a named list with one element per read constraint. Each element is itself
-a list with the following elements:
-
enabled
-
is the constraint enabled ?
-
-
timeStep
-
time step the constraint applies to
-
-
operator
-
type of constraint: equality, inequality on one side or both sides
-
-
coefficients
-
elements containing the coefficients used by the constraint
-
-
values
-
values used by the constraint. It contains one line per time step
-and three columns "less", "greater" and "equal"
-
-
-
The summary method returns a data.frame with one line per constraint.
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
-
Value
-
-
-
A data.table with one line per cluster. The columns of the data.table may
-change between different projects, but there will always be the following
-columns:
-
area
-
Name of the area containing the cluster
-
-
cluster
-
Name of the cluster
-
-
group
-
Type of cluster (gaz, nuclear, etc.)
-
-
unitcount
-
number of production units
-
-
nominalcapacity
-
production capacity of each unit
-
-
-
The other present columns depends on the version of antares and the options
-that have been set: if an option is unset for all clusters, it will not
-appear in the table.
-
-
-
By default, the function reads the cluster description of the default antares
-study. You can use the argument opts to specify another study.
-if(FALSE){
-
-# thermal
-readClusterDesc()
-
-# renewable
-readClusterResDesc()
-
-# st-storage
-readClusterSTDesc()
-
-# By default, the function reads cluster descriptions for the default study,
-# but it is possible to specify another study with parameter "opts"
-sim1<-setSimulationPath()
-
-#[... code that modifies the default antares study]
-
-readClusterDesc(sim1)
-
-}
-
-
readInputRes is a function that reads renewable time series from an antares
-project. But contrary to readAntares, it only reads time series
-stored in the input folder, so it can work in "input" mode.
readInputTS is a function that reads time series from an antares
-project. But contrary to readAntares, it only reads time series
-stored in the input folder, so it can work in "input" mode.
vector of areas names for which load time series must be read.
-
-
-
thermalAvailabilities
-
vector of areas names for which thermal availabilities of clusters must be read.
-
-
-
ror
-
vector of areas names for which run of river time series must be read.
-
-
-
mingen
-
vector of areas names for which Hydro Pmin time series must be read.
-(only for Antares version >= 860)
-
-
-
hydroStorage
-
vector of areas names for which hydrolic storage time series must be read.
-
-
-
hydroStorageMaxPower
-
vector of areas names for which hydrolic storage maximum power time series must be read.
-
-
-
wind
-
vector of areas names for which wind time series must be read
-
-
-
solar
-
vector of areas names for which solar time series must be read
-
-
-
misc
-
vector of areas names for which misc time series must be read
-
-
-
reserve
-
vector of areas names for which reserve time series must be read
-
-
-
linkCapacity
-
vector of links names for which links characteristics time series must be read
-
-
-
resProduction
-
vector of areas names for which renewables clusters production time series must be read.
-
-
-
st_storage
-
vector of areas names for which st-storage clusters production time series must be read.
-
-
-
opts
-
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
timeStep
-
Resolution of the data to import: hourly (default), daily,
-weekly, monthly or annual.
-
-
-
simplify
-
If TRUE and only one type of output is imported then a
-data.table is returned. If FALSE, the result will always be a list of class
-"antaresData".
-
-
-
parallel
-
Should the importation be parallelized ? (See details)
-
-
-
showProgress
-
If TRUE the function displays information about the progress of the
-importation.
-
-
-
-
Value
-
-
-
If simplify = TRUE and only one type of input is imported
-then the result is a data.table with class "antaresDataTable".
-
-
-
Else an object of class "antaresDataList" is returned. It is a list of
-data.tables, each element representing one type of element (load, wind,
-solar, etc.).
-
-
-
Note
-
All parameters expecting a vector of areas or links names also accept the
-special value "all". It indicates the function to read the desired time
-series for all areas or links.
if(FALSE){
-# Set an antares study in "input" mode. This is useful when one want to
-# inspect input time series before running a simulation.
-# Note that readAntares do not function in input mode, but readInputTS
-# works with any mode.
-
-setSimulationPath("path_to_the_study", "input")
-
-# Read load time series
-readInputTS(load ="all")
-
-# Read hydrolic storage and maximum power in the same call:
-readInputTS(hydroStorage ="all", hydroStorageMaxPower ="all")
-
-# Use a different time step
-myArea<-readInputTS(load="myArea", timeStep ="monthly")
-
-# Quick plot to visualize the variability of the series
-matplot(myArea[, -(1:2), with =FALSE], type ="l")
-}
-
-
readInputThermal is a function that reads thermal time series from an antares
-project. But contrary to readAntares, it only reads time series
-stored in the input folder, so it can work in "input" mode.
This function reads in the input files of an antares study the current areas
-layout, ie. the position of the areas It may be useful for plotting the
-network.
-
Be aware that the layout is read in the input files so they may have
-changed since a simulation has been run.
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
xyCompare
-
Use when passing multiple opts, can be "union" or "intersect".
-
-
-
-
Value
-
-
-
A list with three elements:
-
areas:
-
A data.frame containing the name, the color and the coordinate
-of each area
-
-
district:
-
A data.frame containing the name, the color and the coordinate
-of each district
-
-
links:
-
A data.frame containing the name, the coordinates of the origin
-and the destination of each link
-
-
-
By default, readLayout reads the layout for the current default
-antares study. It is possible to specify another study with the parameter
-opts. And we can pass multiple studies using a list of opts.
-
-
-
-
Examples
-
if(FALSE){
-readLayout()
-
-# By default, the function reads layout for the default study,
-# but it is possible to specify another study with parameter "opts"
-sim1<-setSimulationPath()
-
-#[... code that modifies the default antares study]
-
-readLayout(sim1)
-
-}
-
-
This function can be used to read the value of the criteria optimized by ANTARES.
-Notice that these values are only available in "Xpansion" mode or when option
-"Export mps" is turned on.
list of simulation parameters returned by the function
-setSimulationPath
-
-
-
-
Value
-
-
-
A table of class antaresDataTable. It contains the usual columns
-timeID, mcYear, time and two columns "criterion1" and
-"criterion2" containing the values of the criteria. Time step can be daily
-or weekly depending on the optimization options.
This function removes virtual areas from an antaresDataList object and
-corrects the data for the real areas. The antaresDataList object
-should contain area and link data to function correctly.
An object of class antaresDataList with at least components
-areas and links.
-
-
-
storageFlexibility
-
A vector containing the names of the virtual
-storage/flexibility areas. Can also be a named list. Names are columns
-to add and elements the virtual areas to group.
-
-
-
production
-
A vector containing the names of the virtual production
-areas.
-
-
-
reassignCosts
-
If TRUE, the production costs of the virtual areas are
-reallocated to the real areas they are connected to. If the virtual areas
-are connected to a virtual hub, their costs are first reallocated to the
-hub and then the costs of the hub are reallocated to the real areas.
-
-
-
newCols
-
If TRUE, new columns containing the production of the virtual
-areas are added. If FALSE their production is added to the production of
-the real areas they are connected to.
-
-
-
rowBal
-
If TRUE, then BALANCE will be corrected by ROW. BAL:
-BALANCE := BALANCE - "ROW. BAL"
-
-
-
prodVars
-
Virtual productions columns to add to real area.
-Default to getAlias("rmVA_production")
-
-
-
costsVars
-
If parameter reassignCosts is TRUE, affected columns.
-Default to OV. COST, OP. COST, CO2 EMIS. and NP COST
-
-
-
costsOn
-
If parameter reassignCosts is TRUE, then the costs of the
-virtual areas are reassigned to the real areas they are connected to.
-You can choose to reassigned production & storageFlexibility virtuals areas
-("both", default), or only "production" or "storageFlexibility" virtuals areas
-
-
-
-
Value
-
-
-
An antaresDataList object in which virtual areas have been removed and
-data of the real has been corrected. See details for an explanation of the
-corrections.
-
-
-
Details
-
Two types of virtual areas have been defined corresponding to different types
-of modeling in Antares and different types of post-treatment to do:
-
Flexibility/storage areas are areas created to model
-pumping unit or any other flexibility that behave as a storage. For those
-virtual areas, the important results are flows on the links.
-
Production areas are areas created to isolate some generation from
-the "real" areas. They can be isolate for several reasons: to distinguish
-time-series (for example wind onshore/offshore), to select some specific
-unit to participate to day-ahead reserve, etc.
-
removeVirtualAreas performs different corrections:
-
Correct the balance of the real areas (and districts) by removing the flows
-to or from virtual areas.
-
If parameter reassignCosts is TRUE, then the costs of the
-virtual areas are reassigned to the real areas they are connected to. The
-default affected columns are OV. COST, OP. COST, CO2 EMIS.
-and NP COST. If a virtual area is connected to a single real area,
-all its costs are attributed to the real area. If it is connected to
-several real areas, then costs at a given time step are divided between
-them proportionally to the flows between them and the virtual area.
-An aggregation is done at the end to correct districts costs.
-
For each storage/flexibility area, a column named like the area is
-created. It contains the values of the flow between the virtual area and
-the real areas. This column is interpreted as a production of
-electricity: it is positive if the flow from the virtual area to the real
-area is positive and negative otherwise. If parameter newCols is
-FALSE, the values are added to the variable PSP and the
-columns is removed.
-An aggregation is done at the end to add virtual storage/flexibility to districts.
-
If the parameter production is specified, then the non null
-productions of the virtual areas are either added to the ones of the real
-areas they are connected to if newCols = FALSE or put in new
-columns if newCols = TRUE. In the second case the columns are
-named *_virtual where "*" is a type of
-production (wind, solar, nuclear, ...). Productions that are zero for
-all virtual areas are omited.
-If virtual production areas contains clusters then they will be move to the
-real area.
-An aggregation is done at the end to add virtual production to districts.
-
Finally, virtual areas and the links connected to them are removed
-from the data.
-
The functions makes a few assumptions about the network. If they are
-violated it will not act correctly:
-
storage/flexibility
-areas can be connected to other storage/flexibility areas (hubs), but at
-least one of them is connected to a real area. That means that there is
-no group of virtual areas disconnected from the real network. If such a
-group exists, you can either remove them manually or simply not import
-them.
-
production areas are connected to one and only one real area. They
-cannot be connected to virtual areas. But a real area may by connected to
-several production areas.
-
-
-
-
Examples
-
if(FALSE){
-
-# Assume we have a network with two virtual areas acting as pump storage and
-# an area representing offshore production
-#
-# offshore
-# |
-# real area - psp in
-# \
-# psp out
-#
-
-data<-readAntares(areas="all", links="all")
-
-# Remove pump storage virtual areas
-
-correctedData<-removeVirtualAreas(
- x =data,
- storageFlexibility =c("psp in", "psp out"),
- production ="offshore"
-)
-
-correctedData_list<-removeVirtualAreas(
- x =data,
- storageFlexibility =list(PSP =c("psp in", "psp out")),
- production ="offshore"
-)
-
-
-correctedData_details<-removeVirtualAreas(
- x =data,
- storageFlexibility =list(PSP_IN ="psp in", PSP_OUT ="psp out"),
- production ="offshore"
-)
-
-}
-
-
Aliases are short names that can be used in the select parameter in
-function readAntares to tell the function which columns and/or
-type of data to import.
-
setAlias can be used to create a new alias. It can be especially
-useful for package developers to help their users select the data required
-by their packages.
-
getAlias return character vector containing columns and/or types of data
optional vector of alias names. If provided, the full list of
-columns selected by these aliases is displayed. Else only the name and a
-short description of all aliases is displayed.
-
-
-
name
-
Alias name
-
-
-
desc
-
Short description indicating why the new alias is interesting
-
-
-
select
-
character vector containing columns and/or types of data to
-import.
-
-
-
-
Value
-
-
-
setAlias is only used for its side effects. A data.frame with columns
-'name', 'desc' and 'select'. showAliases invisibly returns a
-data.frame with columns "name", "desc" and "select".
-
-
-
-
Examples
-
-# Display the short description of an alias
-showAliases()
-#> name desc
-#> 1 economy Production costs, prices, exchanges and spilled energy
-#> 2 adequacy Adequacy variables
-#> 3 generation Production that can be controlled: thermal and hydrostorage
-#> 4 renewable Renewable productions
-#> 5 thermal Thermal productions
-#> 6 netLoad Variables used to compute net load
-#> 7 rmVA_production removeVirtualAreas production varaibles
-#> 8 nostat All variables except summary variable (MIN, MAX and STD)
-
-# Display the full description of an alias
-showAliases("renewable")
-#> name desc
-#> 4 renewable Renewable productions
-#> select
-#> 4 WIND, WIND OFFSHORE, WIND ONSHORE, SOLAR, SOLAR CONCRT., SOLAR PV, SOLAR ROOFT, RENW. 1, RENW. 2, RENW. 3, RENW. 4, H. ROR, H. STOR, MISC. DTG, MISC. DTG 2, MISC. DTG 3, MISC. DTG 4
-
-getAlias("renewable")
-#> [1] "WIND" "WIND OFFSHORE" "WIND ONSHORE" "SOLAR"
-#> [5] "SOLAR CONCRT." "SOLAR PV" "SOLAR ROOFT" "RENW. 1"
-#> [9] "RENW. 2" "RENW. 3" "RENW. 4" "H. ROR"
-#> [13] "H. STOR" "MISC. DTG" "MISC. DTG 2" "MISC. DTG 3"
-#> [17] "MISC. DTG 4"
-
-if(FALSE){
-# Create a new alias that imports flows
-setAlias("test", "short description", c("links", "FLOW LIN."))
-showAliases()
-}
-
-
This function has to be used before the read functions. It sets the path to
-the Antares simulation to work on and other useful options (list of areas,
-links, areas with clusters, variables, etc.). On local disk with setSimulationPath or
-on an AntaREST API with setSimulationPathAPI
(optional)
-Path to the simulation. It can either be the path to a directory containing
-an antares project or directly to the directory containing the output of a
-simulation. If missing, a window opens and lets the user choose the
-directory of the simulation interactively. Can also choose .h5 file, if rhdf5 is installed.
-
-
-
simulation
-
(optional) Only used if "path" represents the path of a study and not of the
-output of a simulation. It can be either the name of the simulation or a
-number indicating which simulation to use. It is possible to use negative
-values to select a simulation from the last one: for instance -1 will
-select the most recent simulation, -2 will the penultimate one, etc. There
-are two special values 0 and "input" that tells the function that the user
-is not interested by the results of any simulation, but only by the inputs.
-In such a case, the function readAntares is unavailable.
-
-
-
host
-
character host of AntaREST server API
-
-
-
study_id
-
character id of the target study on the API
-
-
-
token
-
character API personnal access token
-
-
-
timeout
-
numeric API timeout (seconds). Default to 60. See also setTimeoutAPI
A list containing various information about the simulation, in particular:
-
studyPath
-
path of the Antares study
-
-
simPath
-
path of the simulation
-
-
inputPath
-
path of the input folder of the study
-
-
studyName
-
Name of the study
-
-
simDataPath
-
path of the folder containing the data of the simulation
-
-
name
-
name of the simulation
-
-
mode
-
type of simulation: economy, adequacy, draft or input
-
-
synthesis
-
Are synthetic results available ?
-
-
yearByYear
-
Are the results for each Monte Carlo simulation available ?
-
-
scenarios
-
Are the Monte-Carlo scenarii stored in output ? This is
-important to reconstruct some input time series that have been used in
-each Monte-Carlo simulation.
-
-
mcYears
-
Vector containing the number of the exported Monte-Carlo scenarios
-
-
antaresVersion
-
Version of Antares used to run the simulation.
-
-
areaList
-
Vector of the available areas.
-
-
districtList
-
Vector of the available districts.
-
-
linkList
-
Vector of the available links.
-
-
areasWithClusters
-
Vector of areas containing clusters.
-
-
variables
-
Available variables for areas, districts and links.
-
-
parameters
-
Other parameters of the simulation.
-
-
timeIdMin
-
Minimum time id of the simulation. It is generally equal to one but can
-be higher if working on a subperiod.
-
-
timeIdMax
-
maximum time id of the simulation.
-
-
start
-
Date of the first day of the year in the simulation. This date corresponds
-to timeId = 1.
-
-
firstWeekday
-
First day of the week.
-
-
districtsDef
-
data.table containing the specification of the districts.
-
-
energyCosts
-
list containing the cost of spilled and unsupplied energy.
-
-
-
sleep
-
timer for api commande execute
-
-
-
-
Details
-
The simulation chosen with setSimulationPath or setSimulationPathAPI becomes the default
-simulation for all functions of the package. This behavior is fine when
-working on only one simulation, but it may become problematic when working
-on multiple simulations at same time.
-
In such case, you can store the object returned by the function in a variable
-and pass this variable to the functions of the package (see examples).
-if(FALSE){
-# Select interactively a study. It only works on windows.
-
-setSimulationPath()
-
-# Specify path of the study. Note: if there are more than one simulation
-# output in the study, the function will asks the user to interactively choose
-# one simulation.
-
-setSimulationPath("path_of_the_folder_of_the_study")
-
-# Select the first simulation of a study
-
-setSimulationPath("path_of_the_folder_of_the_study", 1)
-
-# Select the last simulation of a study
-
-setSimulationPath("path_of_the_folder_of_the_study", -1)
-
-# Select a simulation by name
-
-setSimulationPath("path_of_the_folder_of_the_study", "name of the simulation")
-
-# Just need to read input data
-
-setSimulationPath("path_of_the_folder_of_the_study", "input")
-# or
-setSimulationPath("path_of_the_folder_of_the_study", 0)
-
-# Working with API
-#--------------------------
-setSimulationPathAPI(
- host ="http://antares_api_adress",
- study_id ="study_id_on_api",
- token ="token"
-)
-
-## Custom httr options ?
-
-# global using httr package
-require(httr)
-set_config(verbose())
-setSimulationPathAPI(
- host ="http://antares_api_adress",
- study_id ="study_id_on_api",
- token ="token"
-)
-
-reset_config()
-
-# or in setSimulationPathAPI
-setSimulationPathAPI(
- host ="http://antares_api_adress",
- study_id ="study_id_on_api",
- token ="token",
- httr_config =config(verbose =TRUE)
-)
-
-# disable ssl certificate checking ?
-setSimulationPathAPI(
- host ="http://antares_api_adress",
- study_id ="study_id_on_api",
- token ="token",
- httr_config =config(ssl_verifypeer =FALSE)
-)
-
-# WORKING WITH MULTIPLE SIMULATIONS
-#----------------------------------
-# Let us assume ten simulations have been run and we want to collect the
-# variable "LOAD" for each area. We can create a list containing options
-# for each simulation and iterate through this list.
-
-opts<-lapply(1:10, function(i){
-setSimulationPath("path_of_the_folder_of_the_study", i)
-})
-
-output<-lapply(opts, function(o){
-res<-readAntares(areas ="all", select ="LOAD", timeStep ="monthly", opts =o)
-# Add a column "simulation" containing the name of the simulation
-res$simulation<-o$name
-res
-})
-
-# Concatenate all the tables in one super table
-output<-rbindlist(output)
-
-# Reshape output for easier comparisons: one line per timeId and one column
-# per simulation
-output<-dcast(output, timeId+areaId~simulation, value.var ="LOAD")
-
-output
-
-# Quick visualization
-matplot(output[area==area[1], !c("area", "timeId"), with =FALSE],
- type ="l")
-}
-
-
The function readAntares stores in its output the options used
-to read some data (path of the study, area list, link list, start date,
-etc.).
-
-
-
-
simOptions(x =NULL)
-
-
-
-
Arguments
-
x
-
object of class antaresTable or antaresData
-
-
-
-
Value
-
-
-
list of options used to read the data contained in an object or the last
-simulation options read by setSimulationPath if x is
-NULL
-
-
-
-
-
Details
-
simOptions extracts these options from an object of class
-antaresTable or antaresOutput. It can be useful when working on
-multiple simulations, either to check how some object has been created or to
-use it in some functions like getAreas or
-getLinks
-
If the parameter of the function is NULL, it returns the default
-simulation options, that is the options set by setSimulationPath
-the last time it was run.
-
-
-
-
Examples
-
if(FALSE){
-setSimulationPath(study1)
-
-simOptions()# returns the options for study 1
-
-data<-readAntares()
-
-# Choose a different study
-setSimulationPath(study2)
-
-simOptions()# returns the options for study 2
-
-getAreas()# returns the areas of the secund study
-getAreas(opts =simOptions(data))# returns the areas of the first study
-
-}
-
-
# S3 method for antaresDataList
-subset(x, y =NULL, areas =NULL, timeIds =NULL, mcYears =NULL, ...)
-
-
-
-
Arguments
-
x
-
Object of class antaresDataList created with
-readAntares.
-
-
-
y
-
A table containing at least one of the columns "area", "timeId" or
-"mcYear". If it is not NULL, then only tuples (area, timeId,
- mcYear) present in this table are kept.
-
-
-
areas
-
Vector of area names to keep in the result. If NULL, all
-areas are kept.
-
-
-
timeIds
-
Vector of time ids to keep. If NULL, all time ids are
-kept.
-
-
-
mcYears
-
Vector of monte-carlo years to keep. If NULL, all time
-ids are kept.
-
-
-
...
-
Currently unused.
-
-
-
-
Value
-
-
-
A filtered antaresDataList.
-
-
-
-
Examples
-
if(FALSE){
-#keep only the first year
-mydata<-readAntares(areas ="all", links ="all", mcYears ="all")
-mySubset<-subset(mydata, mcYears =1)
-
-#keep only the first year for areas a and b
-mydata<-readAntares(areas ="all", links ="all", mcYears ="all")
-mySubset<-subset(mydata, mcYears =1, areas=c("a", "b"))
-
-#' #keep only the first year for areas a and b and timeIds include in 5:16
-mydata<-readAntares(areas ="all", links ="all", mcYears ="all")
-mySubset<-subset(mydata, mcYears =1, areas=c("a", "b"), timeIds=5:16)
-
-}
-
-
This function displays each element of an antaresData object in a
-spreadsheet-like viewer.
-
-
-
-
viewAntares(x, ...)
-
-
-
-
Arguments
-
x
-
An object of class antaresData, generated by the function
-readAntares.
-
-
-
...
-
Currently unused
-
-
-
-
Value
-
-
-
Invisible NULL.
-
-
-
-
Examples
-
if(FALSE){
-setSimulationPath()
-
-areas<-readAntares()
-viewAntares(areas)
-
-output<-studyAntares(areas="all", links ="all", clusters ="all")
-viewAntares(output)# Opens three data viewers for each element of output
-}
-
-
boolean add all data with a single call (writeMcAll, misc, thermalAvailabilities, hydroStorage, hydroStorageMaxPower
-reserve, linkCapacity, mustRun, thermalModulation).
-
-
-
writeAllSimulations
-
boolean, write all simulations of your antares study.
-
-
-
nbCores
-
numeric, number of cores to use, only used if writeAllSimulations is TRUE
