Merge pull request #59 from jhollway/develop

Added projection functions

Author: jhollway

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: roctopus
 Title: Utility functions for multimode and multilevel network analysis
-Version: 0.2.3
+Version: 0.2.4
 Description: This package assembles a number of utility functions for 
    loading, visualising, and analysing multimode, multiplex, and multilevel networks.
 URL: https://bitbucket.org/jhollway/roctopus/

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(col_project)
 export(create_lattice)
 export(create_match)
 export(create_nest)
@@ -11,6 +12,7 @@ export(plot_globalnet)
 export(plot_multilevel)
 export(plot_twomode)
 export(project_list)
+export(row_project)
 export(threemode_clustering)
 export(twomode_2x2)
 export(twomode_centralization_between)

NEWS.md

@@ -1,3 +1,11 @@
+# roctopus 0.2.4
+
+2020-07-19
+
+## Package
+
+* Added `row_project()` and `col_project()` functions to make it easier to remember project directions
+
 # roctopus 0.2.3
 
 2020-07-19

R/mm_conversion.R

@@ -82,7 +82,6 @@ project_list <- function(eventlist){
   out
 }
 
-
 #' Transform a data frame to an adjacency or incidence matrix
 #' 
 #' @param df a data frame, with the first column ID
@@ -94,3 +93,21 @@ df_to_mat <- function(df){
   df[,1] <- NULL
   as.matrix(df)
 }
+
+#' Project two-mode matrix into one-mode matrix
+#' 
+#' @name project
+#' @usage row_project(OverSxP)
+#' @param mat a matrix
+#' @return a matrix
+#' @export
+row_project <- function(mat){
+  mat %*% t(mat)
+}
+
+#' @rdname project
+#' @usage col_project(OverSxP)
+#' @export
+col_project <- function(mat){
+  t(mat) %*% mat
+}

tests/testthat/test_project.R

@@ -0,0 +1,13 @@
+context('projection functions')
+
+mat1 <- matrix(c(0,1,1,0,0,1,1,1),2,4)
+mat2 <- matrix(c(2,1,1,3),2,2)
+mat3 <- matrix(c(1,0,1,1,0,1,0,1,1,0,1,1,1,1,1,2),4,4)
+
+test_that("matrix projected correctly by rows",{
+  expect_equal(row_project(mat1), mat2)
+})
+
+test_that("matrix projected correctly by columns",{
+  expect_equal(col_project(mat1), mat3)
+})