diff --git a/.Rbuildignore b/.Rbuildignore index f7becfd4..4e827a28 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,4 @@ test_case/ man-roxygen/ ^codecov\.yml$ ^CRAN-SUBMISSION$ +^LICENSE\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index c731bda2..cafc1089 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,11 +1,11 @@ Package: antaresEditObject Type: Package Title: Edit an 'Antares' Simulation -Version: 0.7.1.9000 +Version: 0.7.1 Authors@R: c( person("Tatiana", "Vargas", email = "tatiana.vargas@rte-france.com", role = c("aut", "cre")), - person("Frederic", "Breant", role = "aut"), - person("Victor", "Perrier", role = c("aut")), + person("Frederic", "Breant", role = "ctb"), + person("Victor", "Perrier", role = c("ctb")), person("Baptiste", "Seguinot", role = "ctb"), person("Benoit", "Thieurmel", role = "ctb"), person("Titouan", "Robert", role = "ctb"), @@ -21,7 +21,7 @@ Authors@R: c( Description: Edit an 'Antares' simulation before running it : create new areas, links, thermal clusters or binding constraints or edit existing ones. Update 'Antares' general & optimization settings. 'Antares' is an open source power system generator, more information available here : . -License: GPL (>= 2) | file LICENSE +License: GPL (>= 2) URL: https://github.com/rte-antares-rpackage/antaresEditObject, https://rte-antares-rpackage.github.io/antaresEditObject/ BugReports: https://github.com/rte-antares-rpackage/antaresEditObject/issues Encoding: UTF-8 @@ -53,5 +53,3 @@ Suggests: knitr, rmarkdown VignetteBuilder: knitr -Remotes: - github::rte-antares-rpackage/antaresRead diff --git a/LICENSE b/LICENSE deleted file mode 100644 index a7d6e138..00000000 --- a/LICENSE +++ /dev/null @@ -1 +0,0 @@ -COPYRIGHT HOLDER: RTE Réseau de transport d’électricité diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..0daa0415 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,336 @@ +GNU General Public License +========================== + +_Version 2, June 1991_ +_Copyright © 1989, 1991 Free Software Foundation, Inc.,_ +_51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA_ + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +### Preamble + +The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + +We protect your rights with two steps: **(1)** copyright the software, and +**(2)** offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + +Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +**0.** This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The “Program”, below, +refers to any such program or work, and a “work based on the Program” +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term “modification”.) Each licensee is addressed as “you”. + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + +**1.** You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + +**2.** You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + +* **a)** You must cause the modified files to carry prominent notices +stating that you changed the files and the date of any change. +* **b)** You must cause any work that you distribute or publish, that in +whole or in part contains or is derived from the Program or any +part thereof, to be licensed as a whole at no charge to all third +parties under the terms of this License. +* **c)** If the modified program normally reads commands interactively +when run, you must cause it, when started running for such +interactive use in the most ordinary way, to print or display an +announcement including an appropriate copyright notice and a +notice that there is no warranty (or else, saying that you provide +a warranty) and that users may redistribute the program under +these conditions, and telling the user how to view a copy of this +License. (Exception: if the Program itself is interactive but +does not normally print such an announcement, your work based on +the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +**3.** You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + +* **a)** Accompany it with the complete corresponding machine-readable +source code, which must be distributed under the terms of Sections +1 and 2 above on a medium customarily used for software interchange; or, +* **b)** Accompany it with a written offer, valid for at least three +years, to give any third party, for a charge no more than your +cost of physically performing source distribution, a complete +machine-readable copy of the corresponding source code, to be +distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, +* **c)** Accompany it with the information you received as to the offer +to distribute corresponding source code. (This alternative is +allowed only for noncommercial distribution and only if you +received the program in object code or executable form with such +an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + +**4.** You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + +**5.** You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +**6.** Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + +**7.** If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + +**8.** If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + +**9.** The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and “any +later version”, you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + +**10.** If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + +### NO WARRANTY + +**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + +**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w` and `show c` should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w` and `show c`; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a “copyright disclaimer” for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/NEWS.md b/NEWS.md index d613f742..08ab744e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# antaresEditObject 0.7.1.9000 +# antaresEditObject 0.7.1 ### Breaking changes : diff --git a/R/computeTimeStepFromHourly.R b/R/computeTimeStepFromHourly.R index f080c494..85b3d38d 100644 --- a/R/computeTimeStepFromHourly.R +++ b/R/computeTimeStepFromHourly.R @@ -128,7 +128,7 @@ # First merge alldaysYearTwo <- data.table(day = alldaysYearTwo, week2 = weekVector) alldaysYearTwo[, year2 := year(day)] - res <- merge(copy(dailydata)[, time := as.Date(time)], alldaysYearTwo, by.x = "time", by.y = "day", all.x = T) + res <- merge(copy(dailydata)[, time := as.Date(time)], alldaysYearTwo, by.x = "time", by.y = "day", all.x = TRUE) # Set up year One alldaysYearOne <- seq(as.Date(paste0(year-1,"-01-01")),as.Date(paste0(year-1,"-12-31")),by="1 day") @@ -144,7 +144,7 @@ # Second merge alldaysYearOne <- data.table(day = alldaysYearOne, week1 = weekVector) alldaysYearOne[, year1 := year(day)] - res <- merge(res, alldaysYearOne, by.x = "time", by.y = "day", all.x = T) + res <- merge(res, alldaysYearOne, by.x = "time", by.y = "day", all.x = TRUE) res[, `:=` (week = ifelse(is.na(week1),week2,week1), year = ifelse(is.na(year1),year2,year1))][, c("week1", "week2", "year1", "year2") := NULL] @@ -156,12 +156,12 @@ if (length(colForMean) > 0){ resMean <- res[, lapply(.SD, function(x){round(mean(x),2)}),.SDcols = colForMean, by= agg_columns] - resFinal <- merge(resSum, resMean, by = agg_columns, sort = F) + resFinal <- merge(resSum, resMean, by = agg_columns, sort = FALSE) } else resFinal <- resSum if (length(colForMax) > 0){ resMean <- res[, lapply(.SD, max),.SDcols = colForMax, by= agg_columns] - resFinal <- merge(resFinal, resMean, by = agg_columns, sort = F) + resFinal <- merge(resFinal, resMean, by = agg_columns, sort = FALSE) } resFinal[, timeId := week] @@ -192,16 +192,16 @@ computeOtherFromHourlyYear <- function(mcYear, areas = "all", opts = simOptions(), timeStep = c("daily", "monthly", "annual", "weekly"), - writeOutput = F){ + writeOutput = FALSE){ res <- list() #for the eval(parse(text)) if (length(areas) == 1) selected <- ifelse(areas == "all", "areas", paste0("'",areas,"'")) else if (type != "links") selected <- paste(list(areas), sep = ",") - else selected <- paste(list(getLinks(areas, internalOnly = T, opts = opts)), + else selected <- paste(list(getLinks(areas, internalOnly = TRUE, opts = opts)), sep = ",") formula <- sprintf('readAntares(%s = %s, timeStep = "hourly", - mcYears = mcYear, showProgress = F, opts = opts)', + mcYears = mcYear, showProgress = FALSE, opts = opts)', type, selected) #read any type data hourlydata <- eval(parse(text = formula)) if (type == "clustersRes" && length(hourlydata) > 1) hourlydata <- hourlydata$clustersRes @@ -209,7 +209,7 @@ computeOtherFromHourlyYear <- function(mcYear, # Multi timestep at once # steps <- as.list(intersect(c("daily", "monthly", "annual"), timeStep)) # res <- llply(steps, .hourlyToOther, hourlydata = hourlydata, type = type, - # .parallel = T, .paropts = list(preschedule=TRUE)) + # .parallel = TRUE, .paropts = list(preschedule=TRUE)) # names(res) <- paste0(steps,"data") # Separate timesteps @@ -246,7 +246,7 @@ computeOtherFromHourlyYear <- function(mcYear, } lapply(res, writeOutputValues, opts = opts) - # llply(res, writeOutputValues, opts = opts, .parallel = T, .paropts = list(preschedule=TRUE)) + # llply(res, writeOutputValues, opts = opts, .parallel = TRUE, .paropts = list(preschedule=TRUE)) } res @@ -283,12 +283,12 @@ computeOtherFromHourlyMulti <- function(opts = simOptions(), type = c("areas", "links", "clusters"), timeStep = c("daily", "monthly", "annual", "weekly"), mcYears = simOptions()$mcYears, - writeOutput = F, + writeOutput = FALSE, nbcl = 8, - verbose = F){ + verbose = FALSE){ if (verbose){ - handlers(global = T) + handlers(global = TRUE) handlers("progress") } diff --git a/R/createClusterST.R b/R/createClusterST.R index 7aecc82f..2e930d5e 100644 --- a/R/createClusterST.R +++ b/R/createClusterST.R @@ -37,11 +37,8 @@ #' - initiallevel = 0.5 (`numeric` \{0;1\}) #' - enabled = TRUE (`logical` TRUE/FALSE) #' -#' ⚠⚠⚠ -#' #' By default, these values don't allow you to have an active cluster (See example section.) #' -#' ⚠⚠⚠ #' #' #' @seealso All the functions needed to manage a storage cluster, diff --git a/cran-comments.md b/cran-comments.md index 73011701..5735195b 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -32,3 +32,29 @@ Failure ('test-createCluster.R:76:5'): Remove all clusters ─────── ## antaresEditObject 0.6.4 Patch version to break abusive dependencies with antaresRead in tests + +## antaresEditObject 0.7.1 + +### Re Submission + + - Check: PDF version of manual, Result: WARNING + LaTeX errors when creating PDF version. + This typically indicates Rd problems. + LaTeX errors found: + ! LaTeX Error: Unicode character (U+26A0) + not set up for use with LaTeX. + +Fix local error (R CMD check antaresEditObject_0.7.1.tar.gz) : + + - When sourcing 'api-variant-management.R': +Erreur : Cannot find the file(s): "../man/figures/badge_api_ok.svg" + + +This error did not appear on the CRAN + +### Re Submission 2 + + - Fix TRUE and FALSE instead of T and F + - `\dontrun{}` sections are needed because most of functions need to be apply on a study load on Global env (legacy code too) + - There is only a maintainer, contributors and RTE, which is the owner. (we use `use_gpl_license(version = 2, include_future = TRUE)`) + diff --git a/man/antaresEditObject-package.Rd b/man/antaresEditObject-package.Rd index d31722e3..79452bf0 100644 --- a/man/antaresEditObject-package.Rd +++ b/man/antaresEditObject-package.Rd @@ -20,14 +20,10 @@ Useful links: \author{ \strong{Maintainer}: Tatiana Vargas \email{tatiana.vargas@rte-france.com} -Authors: -\itemize{ - \item Frederic Breant - \item Victor Perrier -} - Other contributors: \itemize{ + \item Frederic Breant [contributor] + \item Victor Perrier [contributor] \item Baptiste Seguinot [contributor] \item Benoit Thieurmel [contributor] \item Titouan Robert [contributor] diff --git a/man/computeOtherFromHourlyMulti.Rd b/man/computeOtherFromHourlyMulti.Rd index dd14855a..6cd66121 100644 --- a/man/computeOtherFromHourlyMulti.Rd +++ b/man/computeOtherFromHourlyMulti.Rd @@ -10,9 +10,9 @@ computeOtherFromHourlyMulti( type = c("areas", "links", "clusters"), timeStep = c("daily", "monthly", "annual", "weekly"), mcYears = simOptions()$mcYears, - writeOutput = F, + writeOutput = FALSE, nbcl = 8, - verbose = F + verbose = FALSE ) } \arguments{ diff --git a/man/computeOtherFromHourlyYear.Rd b/man/computeOtherFromHourlyYear.Rd index c8d73762..2a77dec4 100644 --- a/man/computeOtherFromHourlyYear.Rd +++ b/man/computeOtherFromHourlyYear.Rd @@ -10,7 +10,7 @@ computeOtherFromHourlyYear( areas = "all", opts = simOptions(), timeStep = c("daily", "monthly", "annual", "weekly"), - writeOutput = F + writeOutput = FALSE ) } \arguments{ diff --git a/man/createClusterST.Rd b/man/createClusterST.Rd index 8c23eb91..1fe32069 100644 --- a/man/createClusterST.Rd +++ b/man/createClusterST.Rd @@ -75,11 +75,7 @@ Study version >= "8.8.0" (update + new parameter) : \item enabled = TRUE (\code{logical} TRUE/FALSE) } -⚠⚠⚠ - By default, these values don't allow you to have an active cluster (See example section.) - -⚠⚠⚠ } \examples{ \dontrun{ diff --git a/vignettes/Antares_new_features_v860.Rmd b/vignettes/Antares_new_features_v860.Rmd index 556fbd50..cc5ddadc 100644 --- a/vignettes/Antares_new_features_v860.Rmd +++ b/vignettes/Antares_new_features_v860.Rmd @@ -2,7 +2,7 @@ title: "Antares new features v8.6.0" output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{Antares_new_features_v860} + %\VignetteIndexEntry{Antares new features v8.6.0} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- diff --git a/vignettes/antaresEditObject.Rmd b/vignettes/antaresEditObject.Rmd index c6dcb8b8..c0588d2f 100644 --- a/vignettes/antaresEditObject.Rmd +++ b/vignettes/antaresEditObject.Rmd @@ -2,7 +2,7 @@ title: "User guide" output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{antaresEditObject} + %\VignetteIndexEntry{User guide} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- diff --git a/vignettes/api-variant-management.Rmd b/vignettes/api-variant-management.Rmd index 39b98fc6..62412afa 100644 --- a/vignettes/api-variant-management.Rmd +++ b/vignettes/api-variant-management.Rmd @@ -107,7 +107,7 @@ writeVariantCommands("path/to/commands.json") Below are listed all functions from {antaresEditObject} that can be used with the API. These functions will include the following badge in their documentation: ```{r, echo=FALSE} -knitr::include_graphics("../man/figures/badge_api_ok.svg") +knitr::include_graphics("figures/badge_api_ok.svg") ```