Skip to contents

Takes a matrix or vector computed on occupied sites only and expands it back to the full site grid, inserting NA for unoccupied sites. This is useful when performing custom analyses on ps$comm (which contains only occupied sites) and mapping the results back to the full raster or spatial object.

Usage

ps_expand(ps, x, spatial = FALSE)

Arguments

ps

A phylospatial object.

x

A matrix (or vector) with nrow(ps$comm) rows (i.e. one row per occupied site).

spatial

Logical: if TRUE, convert the expanded result to a spatial object using ps$spatial. Default is FALSE.

Value

If spatial = FALSE, a matrix with ps$n_sites rows and NA for unoccupied sites. If spatial = TRUE, a SpatRaster or sf object.

Examples

ps <- ps_simulate()

# custom analysis on the occupied-only community matrix
site_totals <- matrix(rowSums(ps$comm), ncol = 1)
colnames(site_totals) <- "total"

# expand to full extent as a matrix
ps_expand(ps, site_totals)
#>               total
#>   [1,] 3.806050e+00
#>   [2,] 4.029186e+00
#>   [3,] 4.118845e+00
#>   [4,] 4.111089e+00
#>   [5,] 4.020219e+00
#>   [6,] 3.902304e+00
#>   [7,] 3.710837e+00
#>   [8,] 3.413509e+00
#>   [9,] 3.003283e+00
#>  [10,] 2.481958e+00
#>  [11,] 2.030624e+00
#>  [12,] 1.591723e+00
#>  [13,] 1.104332e+00
#>  [14,] 5.977213e-01
#>  [15,] 3.177702e-01
#>  [16,] 8.163780e-02
#>  [17,]           NA
#>  [18,]           NA
#>  [19,]           NA
#>  [20,]           NA
#>  [21,] 4.404859e+00
#>  [22,] 4.605033e+00
#>  [23,] 4.665580e+00
#>  [24,] 4.647449e+00
#>  [25,] 4.608885e+00
#>  [26,] 4.522067e+00
#>  [27,] 4.338276e+00
#>  [28,] 4.040469e+00
#>  [29,] 3.613070e+00
#>  [30,] 3.062869e+00
#>  [31,] 2.406714e+00
#>  [32,] 1.876097e+00
#>  [33,] 1.367614e+00
#>  [34,] 8.194555e-01
#>  [35,] 4.914332e-01
#>  [36,] 1.930367e-01
#>  [37,] 4.942279e-03
#>  [38,]           NA
#>  [39,]           NA
#>  [40,]           NA
#>  [41,] 4.950039e+00
#>  [42,] 5.042038e+00
#>  [43,] 5.094952e+00
#>  [44,] 5.108816e+00
#>  [45,] 5.128267e+00
#>  [46,] 5.055783e+00
#>  [47,] 4.886838e+00
#>  [48,] 4.598517e+00
#>  [49,] 4.144373e+00
#>  [50,] 3.556479e+00
#>  [51,] 2.863943e+00
#>  [52,] 2.101203e+00
#>  [53,] 1.571292e+00
#>  [54,] 1.004999e+00
#>  [55,] 6.501923e-01
#>  [56,] 2.988775e-01
#>  [57,] 6.010439e-02
#>  [58,]           NA
#>  [59,]           NA
#>  [60,]           NA
#>  [61,] 4.985201e+00
#>  [62,] 5.251150e+00
#>  [63,] 5.385417e+00
#>  [64,] 5.496090e+00
#>  [65,] 5.549991e+00
#>  [66,] 5.487818e+00
#>  [67,] 5.322311e+00
#>  [68,] 5.078065e+00
#>  [69,] 4.559027e+00
#>  [70,] 3.940549e+00
#>  [71,] 3.214713e+00
#>  [72,] 2.396850e+00
#>  [73,] 1.706617e+00
#>  [74,] 1.124958e+00
#>  [75,] 7.658902e-01
#>  [76,] 4.035997e-01
#>  [77,] 1.083569e-01
#>  [78,] 7.771270e-04
#>  [79,]           NA
#>  [80,]           NA
#>  [81,] 4.972649e+00
#>  [82,] 5.321973e+00
#>  [83,] 5.557026e+00
#>  [84,] 5.778058e+00
#>  [85,] 5.879653e+00
#>  [86,] 5.807735e+00
#>  [87,] 5.595690e+00
#>  [88,] 5.268883e+00
#>  [89,] 4.800932e+00
#>  [90,] 4.198058e+00
#>  [91,] 3.442344e+00
#>  [92,] 2.589354e+00
#>  [93,] 1.763842e+00
#>  [94,] 1.194583e+00
#>  [95,] 8.337101e-01
#>  [96,] 4.649957e-01
#>  [97,] 1.490172e-01
#>  [98,] 3.865970e-02
#>  [99,]           NA
#> [100,]           NA
#> [101,] 4.892236e+00
#> [102,] 5.297936e+00
#> [103,] 5.619763e+00
#> [104,] 5.955550e+00
#> [105,] 6.133865e+00
#> [106,] 6.010241e+00
#> [107,] 5.725234e+00
#> [108,] 5.351185e+00
#> [109,] 4.895190e+00
#> [110,] 4.365878e+00
#> [111,] 3.544198e+00
#> [112,] 2.666149e+00
#> [113,] 1.752420e+00
#> [114,] 1.212620e+00
#> [115,] 8.505992e-01
#> [116,] 4.810855e-01
#> [117,] 1.814392e-01
#> [118,] 6.876555e-02
#> [119,]           NA
#> [120,]           NA
#> [121,] 4.723157e+00
#> [122,] 5.161727e+00
#> [123,] 5.537565e+00
#> [124,] 5.950367e+00
#> [125,] 6.342033e+00
#> [126,] 6.041226e+00
#> [127,] 5.685400e+00
#> [128,] 5.271756e+00
#> [129,] 4.787730e+00
#> [130,] 4.214174e+00
#> [131,] 3.523692e+00
#> [132,] 2.702267e+00
#> [133,] 1.772380e+00
#> [134,] 1.243278e+00
#> [135,] 8.387404e-01
#> [136,] 4.517922e-01
#> [137,] 2.050542e-01
#> [138,] 9.063377e-02
#> [139,]           NA
#> [140,]           NA
#> [141,] 4.451195e+00
#> [142,] 4.894772e+00
#> [143,] 5.273273e+00
#> [144,] 5.649380e+00
#> [145,] 5.877112e+00
#> [146,] 5.751142e+00
#> [147,] 5.428521e+00
#> [148,] 5.041850e+00
#> [149,] 4.652645e+00
#> [150,] 4.158247e+00
#> [151,] 3.534924e+00
#> [152,] 2.782779e+00
#> [153,] 1.925987e+00
#> [154,] 1.497428e+00
#> [155,] 1.012512e+00
#> [156,] 4.821529e-01
#> [157,] 2.194150e-01
#> [158,] 1.039066e-01
#> [159,]           NA
#> [160,]           NA
#> [161,] 4.090688e+00
#> [162,] 4.515768e+00
#> [163,] 4.881883e+00
#> [164,] 5.166048e+00
#> [165,] 5.379493e+00
#> [166,] 5.261778e+00
#> [167,] 5.042124e+00
#> [168,] 4.793841e+00
#> [169,] 4.453182e+00
#> [170,] 4.010829e+00
#> [171,] 3.451429e+00
#> [172,] 2.763926e+00
#> [173,] 2.102228e+00
#> [174,] 1.700323e+00
#> [175,] 1.216584e+00
#> [176,] 7.515544e-01
#> [177,] 3.560437e-01
#> [178,] 1.083569e-01
#> [179,]           NA
#> [180,]           NA
#> [181,] 3.674718e+00
#> [182,] 4.046160e+00
#> [183,] 4.380386e+00
#> [184,] 4.598859e+00
#> [185,] 4.711190e+00
#> [186,] 4.679600e+00
#> [187,] 4.613476e+00
#> [188,] 4.435158e+00
#> [189,] 4.162252e+00
#> [190,] 3.787623e+00
#> [191,] 3.297150e+00
#> [192,] 2.672187e+00
#> [193,] 2.257008e+00
#> [194,] 1.858371e+00
#> [195,] 1.422723e+00
#> [196,] 1.009147e+00
#> [197,] 6.094376e-01
#> [198,] 1.773300e-01
#> [199,]           NA
#> [200,]           NA
#> [201,] 3.207835e+00
#> [202,] 3.535022e+00
#> [203,] 3.795327e+00
#> [204,] 3.978393e+00
#> [205,] 4.020077e+00
#> [206,] 4.097951e+00
#> [207,] 4.107153e+00
#> [208,] 4.000730e+00
#> [209,] 3.796449e+00
#> [210,] 3.501364e+00
#> [211,] 3.088711e+00
#> [212,] 2.664182e+00
#> [213,] 2.381285e+00
#> [214,] 2.022918e+00
#> [215,] 1.629667e+00
#> [216,] 1.240703e+00
#> [217,] 8.156499e-01
#> [218,] 3.627175e-01
#> [219,] 5.790411e-05
#> [220,]           NA
#> [221,] 2.698892e+00
#> [222,] 2.998995e+00
#> [223,] 3.211432e+00
#> [224,] 3.322700e+00
#> [225,] 3.364803e+00
#> [226,] 3.494684e+00
#> [227,] 3.529241e+00
#> [228,] 3.496749e+00
#> [229,] 3.371364e+00
#> [230,] 3.155147e+00
#> [231,] 2.921528e+00
#> [232,] 2.778389e+00
#> [233,] 2.546065e+00
#> [234,] 2.216816e+00
#> [235,] 1.836419e+00
#> [236,] 1.414784e+00
#> [237,] 9.651262e-01
#> [238,] 4.935800e-01
#> [239,] 1.160820e-01
#> [240,] 1.146117e-01
#> [241,] 2.140832e+00
#> [242,] 2.418737e+00
#> [243,] 2.611336e+00
#> [244,] 2.710060e+00
#> [245,] 2.836365e+00
#> [246,] 3.050091e+00
#> [247,] 3.044103e+00
#> [248,] 2.978107e+00
#> [249,] 2.913448e+00
#> [250,] 2.884139e+00
#> [251,] 2.984446e+00
#> [252,] 3.009478e+00
#> [253,] 2.769804e+00
#> [254,] 2.390860e+00
#> [255,] 1.965565e+00
#> [256,] 1.515665e+00
#> [257,] 1.070209e+00
#> [258,] 8.144147e-01
#> [259,] 5.562612e-01
#> [260,] 4.855602e-01
#> [261,] 1.560663e+00
#> [262,] 1.800432e+00
#> [263,] 1.978698e+00
#> [264,] 2.429369e+00
#> [265,] 2.783171e+00
#> [266,] 3.060360e+00
#> [267,] 3.079197e+00
#> [268,] 2.877071e+00
#> [269,] 2.654965e+00
#> [270,] 2.889255e+00
#> [271,] 3.089060e+00
#> [272,] 3.288016e+00
#> [273,] 2.869673e+00
#> [274,] 2.436534e+00
#> [275,] 1.989287e+00
#> [276,] 1.528174e+00
#> [277,] 1.296647e+00
#> [278,] 1.095270e+00
#> [279,] 9.291097e-01
#> [280,] 8.565087e-01
#> [281,] 1.253616e+00
#> [282,] 1.346916e+00
#> [283,] 1.788427e+00
#> [284,] 2.287672e+00
#> [285,] 2.721395e+00
#> [286,] 3.091448e+00
#> [287,] 3.212450e+00
#> [288,] 3.122687e+00
#> [289,] 2.919154e+00
#> [290,] 2.797811e+00
#> [291,] 2.925451e+00
#> [292,] 2.932496e+00
#> [293,] 2.693337e+00
#> [294,] 2.316157e+00
#> [295,] 1.893049e+00
#> [296,] 1.507995e+00
#> [297,] 1.378784e+00
#> [298,] 1.283259e+00
#> [299,] 1.210907e+00
#> [300,] 1.227457e+00
#> [301,] 9.316432e-01
#> [302,] 1.089094e+00
#> [303,] 1.785980e+00
#> [304,] 2.440138e+00
#> [305,] 3.026191e+00
#> [306,] 3.564536e+00
#> [307,] 3.563939e+00
#> [308,] 3.304300e+00
#> [309,] 2.968812e+00
#> [310,] 2.574019e+00
#> [311,] 2.597853e+00
#> [312,] 2.554242e+00
#> [313,] 2.368514e+00
#> [314,] 2.064556e+00
#> [315,] 1.689791e+00
#> [316,] 1.378797e+00
#> [317,] 1.289995e+00
#> [318,] 1.286748e+00
#> [319,] 1.293698e+00
#> [320,] 1.598406e+00
#> [321,] 8.315344e-01
#> [322,] 1.074543e+00
#> [323,] 1.805350e+00
#> [324,] 2.510617e+00
#> [325,] 3.195738e+00
#> [326,] 4.029041e+00
#> [327,] 3.623591e+00
#> [328,] 3.211939e+00
#> [329,] 2.778609e+00
#> [330,] 2.297903e+00
#> [331,] 2.209436e+00
#> [332,] 2.152603e+00
#> [333,] 1.989074e+00
#> [334,] 1.735050e+00
#> [335,] 1.406691e+00
#> [336,] 1.091261e+00
#> [337,] 1.071154e+00
#> [338,] 1.067273e+00
#> [339,] 1.107321e+00
#> [340,] 1.227457e+00
#> [341,] 7.401391e-01
#> [342,] 8.949807e-01
#> [343,] 1.602122e+00
#> [344,] 2.262689e+00
#> [345,] 2.835940e+00
#> [346,] 3.163901e+00
#> [347,] 3.111783e+00
#> [348,] 2.773883e+00
#> [349,] 2.338357e+00
#> [350,] 1.829962e+00
#> [351,] 1.791456e+00
#> [352,] 1.729149e+00
#> [353,] 1.578521e+00
#> [354,] 1.358161e+00
#> [355,] 1.067183e+00
#> [356,] 7.513549e-01
#> [357,] 7.050689e-01
#> [358,] 6.696607e-01
#> [359,] 7.886985e-01
#> [360,] 8.565087e-01
#> [361,] 6.421042e-01
#> [362,] 7.171888e-01
#> [363,] 1.193860e+00
#> [364,] 1.757907e+00
#> [365,] 2.181319e+00
#> [366,] 2.350799e+00
#> [367,] 2.270367e+00
#> [368,] 2.050257e+00
#> [369,] 1.670098e+00
#> [370,] 1.340326e+00
#> [371,] 1.352043e+00
#> [372,] 1.286760e+00
#> [373,] 1.144977e+00
#> [374,] 9.484748e-01
#> [375,] 7.091253e-01
#> [376,] 4.734375e-01
#> [377,] 2.243271e-01
#> [378,] 3.121133e-01
#> [379,] 4.254197e-01
#> [380,] 4.855602e-01
#> [381,] 5.623756e-01
#> [382,] 5.934157e-01
#> [383,] 6.379226e-01
#> [384,] 1.099641e+00
#> [385,] 1.424374e+00
#> [386,] 1.542429e+00
#> [387,] 1.423334e+00
#> [388,] 1.139611e+00
#> [389,] 8.297871e-01
#> [390,] 8.931359e-01
#> [391,] 8.937744e-01
#> [392,] 8.266325e-01
#> [393,] 6.921321e-01
#> [394,] 5.439629e-01
#> [395,] 3.784158e-01
#> [396,] 1.668938e-01
#> [397,] 7.184642e-02
#> [398,] 2.395089e-02
#> [399,] 6.894585e-02
#> [400,] 1.146117e-01

# expand and convert to spatial
ps_expand(ps, site_totals, spatial = TRUE)
#> class       : SpatRaster
#> size        : 20, 20, 1  (nrow, ncol, nlyr)
#> resolution  : 1, 1  (x, y)
#> extent      : 0, 20, 0, 20  (xmin, xmax, ymin, ymax)
#> coord. ref. : 
#> source(s)   : memory
#> varname     : total
#> name        :    total
#> min value   : 0.000058
#> max value   : 6.342033