Including datasets to use on Denne´s example

Now you can load example dataset directly from data() function.
antoanne · Jun 24, 2021 · 0a1564b · 0a1564b
1 parent 27e8d94
commit 0a1564b
Show file tree

Hide file tree

Showing 31 changed files with 79 additions and 41 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,2 +1,3 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^data-raw$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,10 +1,13 @@
 Package: ifm
 Type: Package
 Title: Financial evaluation of Projects
-Version: 0.1.0
+Version: 0.2.0
 Author: Antoanne Christopher Pontes Wanderley
 Authors@R: c(
     person("Antoanne", "Pontes", email = "[email protected]", role = c("aut", "ctb", "cre")),
+    person("Elton", "Marinho", email = "[email protected]", role = c("ctb")),
+    person("Monica", "Silva", email = "[email protected]", role = c("ctb")),
+    person("Sergio", "Serra", email = "[email protected]", role = c("ctb")),
     person("Eber", "Schmitz", email = "[email protected]", role = c("ctb")),
     person("Alexandre", "Costa", email = "[email protected]", role = "ctb"),
     person("Anderson", "Nepomuceno", email = "[email protected]", role = "ctb"),
@@ -25,3 +28,5 @@ NeedsCompilation: no
 RoxygenNote: 7.1.1
 Imports: igraph, XLConnect, openxlsx, RUnit
 Date: 2018-07-31
+Depends: R (>= 2.10)
+LazyData: true
diff --git a/R/data.R b/R/data.R
@@ -0,0 +1,7 @@
+#' Sample dataset following Denne sample.
+#'
+#' TODO
+#'
+#' @format A data frame with 6 variables:
+#'
+"ex.sheet.data"
diff --git a/R/excel.list.to.xls.R b/R/excel.list.to.xls.R
@@ -31,7 +31,7 @@
 #'
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/excel.xls.to.list.R b/R/excel.xls.to.list.R
@@ -25,11 +25,9 @@
 #'
 #' @import XLConnect
 #'
-#' @examples
-#'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
-#'
-#'
+
+# ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+
 excel.xls.to.list <- excel_xls_to_list <- excelXlsToList <-
   function(xls.spreadsheet.path){
 

diff --git a/R/mmf.df.1r.R b/R/mmf.df.1r.R
@@ -9,7 +9,7 @@
 #' @export
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/mmf.df.infr.R b/R/mmf.df.infr.R
@@ -7,7 +7,7 @@
 #' @export
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/mmf.get.breakeven.R b/R/mmf.get.breakeven.R
@@ -8,7 +8,7 @@
 #' @family scheduling
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/mmf.get.selffunding.R b/R/mmf.get.selffunding.R
@@ -8,7 +8,7 @@
 #' @family scheduling
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/mmf.max.npv.R b/R/mmf.max.npv.R
@@ -10,7 +10,7 @@
 #' @export
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/mmf.npv.R b/R/mmf.npv.R
@@ -25,8 +25,7 @@
 #'
 #' @examples
 #'
-#' # Loading data from XLS
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 #' ex.sheet.data.activities <- ex.sheet.data[[2]]
 #' ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/R/predecessors.to.edges.R b/R/predecessors.to.edges.R
@@ -20,7 +20,7 @@
 #'
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' ex.edges <- predecessors.to.edges(ex.sheet.data$predecessors)
 #'
 predecessors.to.edges <- predecessors_to_edges <- predecessorsToEdges <-

diff --git a/R/utils.R b/R/utils.R
@@ -17,7 +17,7 @@
 #'
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' act.pred <- utils.suc2pred(ex.sheet.data$predecessors)
 #'
 utils.suc2pred <- function(activities.successors) {
@@ -58,7 +58,7 @@ utils.suc2pred <- function(activities.successors) {
 #'
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' act.suc <- utils.pred2suc(ex.sheet.data$predecessors)
 #'
 utils.pred2suc <- function(activities.predecessors) {
@@ -100,7 +100,7 @@ utils.pred2suc <- function(activities.predecessors) {
 #'
 #' @examples
 #'
-#' ex.sheet.data <- excel.xls.to.list("../ifm/demo/resources/spreadsheet.xls")
+#' data("ex.sheet.data")
 #' g <- utils.pred2graph(ex.sheet.data$predecessors)
 #' plot(g)
 #'

diff --git a/README.md b/README.md
@@ -5,10 +5,23 @@ This is part of the research project that aims to understand how we can enhance
 
 To use this package please do the following steps:
 
-1 - install / download (git clone) R ifm package;
+Install on R
 
-2 - fill the spreadsheet and validate the named ranges: interestrate, activities, etc...
+Use this command: devtools::install_github("antoanne/ifmFramework", INSTALL_opts=c("--no-multiarch"))
 
-3 - put the spreadsheet on the /resources directory;
 
-4 - run the function xpto.
+Execute sample following this steps
+
+1. Import IFM package
+library(ifm)
+
+2. Load demo
+demo(sampledenne)
+
+
+
+
+
+
+References
+Denne, M., & Cleland-Huang, J. (2003). Software by numbers: Low-risk, high-return development. Prentice Hall Professional.
diff --git a/demo/resources/spreadsheet.xls → data-raw/spreadsheet.xls b/demo/resources/spreadsheet.xls → data-raw/spreadsheet.xls
diff --git a/data-raw/workbook.R b/data-raw/workbook.R
@@ -0,0 +1,6 @@
+library(XLConnect)
+library(ifm)
+
+ex.sheet.data <- excel.xls.to.list('data-raw/spreadsheet.xls')
+
+usethis::use_data(ex.sheet.data, overwrite = TRUE)
diff --git a/data/ex.sheet.data.rda b/data/ex.sheet.data.rda
diff --git a/demo/sampledenne.R b/demo/sampledenne.R
@@ -2,7 +2,7 @@ library(ifm)
 library(igraph)
 library(XLConnect)
 
-ex.sheet.data <- excel.xls.to.list('demo/resources/spreadsheet.xls')
+data("ex.sheet.data")
 ex.sheet.data.interest.rate <- ex.sheet.data[[1]]
 ex.sheet.data.activities <- ex.sheet.data[[2]]
 ex.sheet.data.durations <- ex.sheet.data[[3]]

diff --git a/man/ex.sheet.data.Rd b/man/ex.sheet.data.Rd
diff --git a/man/excel.list.to.xls.Rd b/man/excel.list.to.xls.Rd
diff --git a/man/excel.xls.to.list.Rd b/man/excel.xls.to.list.Rd
diff --git a/man/mmf.df.1r.Rd b/man/mmf.df.1r.Rd
diff --git a/man/mmf.df.infr.Rd b/man/mmf.df.infr.Rd
diff --git a/man/mmf.get.breakeven.Rd b/man/mmf.get.breakeven.Rd
diff --git a/man/mmf.get.selffunding.Rd b/man/mmf.get.selffunding.Rd
diff --git a/man/mmf.max.npv.Rd b/man/mmf.max.npv.Rd
diff --git a/man/mmf.npv.Rd b/man/mmf.npv.Rd
diff --git a/man/predecessors.to.edges.Rd b/man/predecessors.to.edges.Rd
diff --git a/man/utils.pred2graph.Rd b/man/utils.pred2graph.Rd
diff --git a/man/utils.pred2suc.Rd b/man/utils.pred2suc.Rd
diff --git a/man/utils.suc2pred.Rd b/man/utils.suc2pred.Rd