add some references and update readme

Author: Carol-seven

R/RcppExports.R

@@ -12,6 +12,9 @@
 #' @param alpha The tuning parameter controlling the weights for SP strength and
 #' prior information. The default setting is 1.
 #' @param type Which type of SP to calculate: "consumption"/"pull" (default) or "distribution"/"push".
+#' @references Xiao, S., Yan, J. and Zhang, P. (2022).
+#' "Incorporating Auxiliary Information in Betweenness Measure for Input-Output Networks".
+#' \emph{Physica A: Statistical Mechanics and its Applications}, 607, 128200.
 #' @return Lists of betweeness score, associated SPs, SP distance and SP strength.
 #' @export
 btw <- function(adjmat, gross, prior, alpha = 1, type = "consumption") {
@@ -20,8 +23,14 @@ btw <- function(adjmat, gross, prior, alpha = 1, type = "consumption") {
 
 #' Dijkstra's algorithm
 #'
+#' Implement the Dijkstra's algorithm to find the shortest paths
+#' from the source node to all nodes in the given network.
+#'
 #' @param adjmat The adjacency matrix of an directed and weighted network.
 #' @param src The given source node to find the shortest distance.
+#' @references Dijkstra, E. W. (1959).
+#' "A Note on Two Problems in Connexion with Graphs".
+#' \emph{Numerische Mathematik}, 1, 269--271.
 #' @return Lists of distance, previous node.
 #' @export
 dijkstra <- function(adjmat, src) {

R/data_WIOD.R

@@ -14,10 +14,10 @@
 #' \itemize{
 #' \item Dietzenbacher, E., Los, B., Stehrer R., Timmer, M. P. and de Vries, G. J. (2013).
 #' "The Construction of World Input-Output Tables in the WIOD Project".
-#' \emph{Economic Systems Research}, 25(1): 71--98.
+#' \emph{Economic Systems Research}, 25(1), 71--98.
 #' \item Timmer, M. P., Dietzenbacher, E., Los, B., Stehrer, R. and de Vries, G. J. (2015).
 #' "An Illustrated User Guide to the World Input-Output Database: the Case of Global Automotive Production".
-#' \emph{Review of International Economics}, 23(3): 575--605.
+#' \emph{Review of International Economics}, 23(3), 575--605.
 #' \item Timmer, M. P., Los, B., Stehrer, R. and de Vries, G. J. (2016).
 #' "An Anatomy of the Global Trade Slowdown based on the WIOD 2016 Release".
 #' \emph{GGDC Research Memorandum 162, University of Groningen}.

README.md

@@ -27,24 +27,32 @@ devtools::install_github("Carol-seven/ionet")
 `btw()`: betweenness centrality measure that incorporates available
 node-specific auxiliary information based on strongest path.
 
+`data_WIOD()`: get data from the World Input-Output Database (WIOD).
+
+`dijkstra()`: implementation of the Dijkstra's algorithm to find the shortest paths
+from the source node to all nodes in the given network.
+
 ## Data \| Input-Output Tables
 
-| Database                                   | Economies |  Sectors  | Years |
-|:-------------------------------------------|:---------:|:---------:|:-----:|
-| the National Bureau of Statistics of China |   China   |   2002    |  122  |
-|                                            |           |   2005    |  42   |
-|                                            |           |   2007    |  135  |
-|                                            |           |   2010    |  41   |
-|                                            |           |   2012    |  139  |
-|                                            |           |   2015    |  42   |
-|                                            |           |   2017    |  149  |
-|                                            |           |   2017    |  42   |
-|                                            |           |   2018    |  153  |
-|                                            |           |   2018    |  42   |
-|                                            |           |   2020    |  153  |
-|                                            |           |   2020    |  42   |
-| OECD Input-Output Tables 2021 edition      |   China   | 1995–2018 |  45   |
-| OECD Input-Output Tables 2021 edition      |   Japan   | 1995–2018 |  45   |
+| Database                                   | Economies | Years      |Sectors|     Notes     |
+|:-------------------------------------------|:---------:|:----------:|:-----:|:-------------:|
+| the National Bureau of Statistics of China |   China   |   2002     |  122  |   Built-in    |
+|                                            |           |   2005     |  42   |
+|                                            |           |   2007     |  135  |
+|                                            |           |   2010     |  41   |
+|                                            |           |   2012     |  139  |
+|                                            |           |   2015     |  42   |
+|                                            |           |   2017     |  149  |
+|                                            |           |   2017     |  42   |
+|                                            |           |   2018     |  153  |
+|                                            |           |   2018     |  42   |
+|                                            |           |   2020     |  153  |
+|                                            |           |   2020     |  42   |
+| OECD Input-Output Tables 2021 edition      |   China   | 1995--2018 |  45   |   Built-in    |
+| OECD Input-Output Tables 2021 edition      |   Japan   | 1995--2018 |  45   |   Built-in    |
+| WIOD 2013 Release                          |  40+RoW   | 1995--2011 |  35   | `data_WIOD()` |
+| WIOD 2016 Release                          |  43+RoW   | 2000--2014 |  56   | `data_WIOD()` |
+| Long-run WIOD                              |  25+RoW   | 1965--2000 |  23   | `data_WIOD()` |
 
 ## Recommended Citation
 

man/btw.Rd

@@ -14,6 +14,9 @@ using namespace Rcpp;
 //' @param alpha The tuning parameter controlling the weights for SP strength and
 //' prior information. The default setting is 1.
 //' @param type Which type of SP to calculate: "consumption"/"pull" (default) or "distribution"/"push".
+//' @references Xiao, S., Yan, J. and Zhang, P. (2022).
+//' "Incorporating Auxiliary Information in Betweenness Measure for Input-Output Networks".
+//' \emph{Physica A: Statistical Mechanics and its Applications}, 607, 128200.
 //' @return Lists of betweeness score, associated SPs, SP distance and SP strength.
 //' @export
 // [[Rcpp::export]]

man/data_WIOD.Rd

@@ -26,8 +26,14 @@ int minDist(NumericVector dist, LogicalVector doneSet) {
 
 //' Dijkstra's algorithm
 //'
+//' Implement the Dijkstra's algorithm to find the shortest paths
+//' from the source node to all nodes in the given network.
+//'
 //' @param adjmat The adjacency matrix of an directed and weighted network.
 //' @param src The given source node to find the shortest distance.
+//' @references Dijkstra, E. W. (1959).
+//' "A Note on Two Problems in Connexion with Graphs".
+//' \emph{Numerische Mathematik}, 1, 269--271.
 //' @return Lists of distance, previous node.
 //' @export
 // [[Rcpp::export]]