spatial_stats 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45774fe6829810899c98f75430ac47a135f839762663381e9621f983e7a0baa
-  data.tar.gz: 719b2421748188426d1c44b73c00744d66a65b8ac5e23034a22d875da5fbfd61
+  metadata.gz: 3e79499aff738642d7e50a0255239de6627e68b3e1553f8aa6fa21364c3b5acb
+  data.tar.gz: 26a98ee5cb279af10e2cc324663e06ddfc7217eb6a6adc3d4052cc6469b5b6be
 SHA512:
-  metadata.gz: 8ab6221b26cd81ab2af42d195349d188ec482d6cb346677a28d3a69c16e8472060645938f806df6f14ee76eabef11d0e7e12904513b47b005ebf75d6e898caac
-  data.tar.gz: 2d0a3df4f22008bef642dcff5c74b2ae8c8c4590314ea110a58fedf8a4c949649ba649f8bca77016fb1a0cf49d0571eee7fecd007d610d873693f98a8fbab6b6
+  metadata.gz: a184a7e6561ec950ecc97e08840c8e88ba7bb20567d140036c34e0552a0e11a339885094fa5380e59f1a7ebe4eee0cb371368e6a7384531c7704e9894c8c1948
+  data.tar.gz: cd971928ff328e8daca3b0176b01903bdc98d7fcf1109cdbf9937dd84ff737d2d8072b7437e21dc0c2f26c73738c7c7f30c9a7bdca30b5cfd655ef5f3f760df1

data/README.md

@@ -1,5 +1,7 @@
 [![Build Status](https://travis-ci.com/keithdoggett/spatial_stats.svg?branch=master)](https://travis-ci.com/keithdoggett/spatial_stats)
 
+![Spatial Stats](/assets/ruby.svg)
+
 # SpatialStats
 
 SpatialStats is an ActiveRecord plugin that utilizes PostGIS and Ruby to compute weights/statistics of spatial data sets in Rails Apps.
@@ -138,8 +140,8 @@ field = nil
 moran = SpatialStats::Global::Moran.new(scope, field, weights)
 # => <SpatialStats::Global::Moran>
 
-# important to standardize the data!
-data = [1,2,3,4,5,6].standardize
+# data is automatically standardized on input
+data = [1,2,3,4,5,6]
 moran.x = data
 
 moran.stat
@@ -219,8 +221,8 @@ field = nil
 moran = SpatialStats::Local::Moran.new(scope, field, weights)
 # => <SpatialStats::Local::Moran>
 
-# important to standardize the data!
-data = [1,2,3,4,5,6].standardize
+# data is automatically standardized on input
+data = [1,2,3,4,5,6]
 moran.x = data
 
 moran.stat
@@ -310,50 +312,30 @@ RGeo::Geos.supported?
 # => true
 ```
 
-## TODO
-
-- ~~Memoize expensive functions within classes~~
-- ~~Make star a parameter to getis-ord class~~
-- ~~Add examples/usage to docs~~
-- ~~Create RDocs~~
-- ~~Refactor Global Moran and BVMoran~~
-- ~~Support non-numeric keys in WeightsMatrix/General refactor~~
-- ~~Write SparseMatrix C ext~~
-- ~~Change instances of `standardized` and `windowed` to `standardize` and `window`, respectively.~~
-- ~~Add `positive` and `negative` groups for `GetisOrd` and `Geary`, similar to how `#quads` is implemented.~~
-- ~~Add `#summary` method to statistics that will combine stat vals with p-vals, and quads or hot/cold spot info.~~
-- ~~Add ability to assign `x` or `z` on stat classes so users are not forced to query data to input it into models. Add example to README.~~
-
-## Future Work
-
-#### General
-
-- ~~Refactor stats to inherit an abstract class.~~
-- ~~Change WeightsMatrix class and Stat classes to utilize sparse matrix methods.~~
-- Split into two separate gems spatial_stats and spatial_stats-activerecord
-
-#### Weights
-
-- Add Kernel based weighting
-
-#### Utils
-
-- Rate smoothing
-- Bayes smoothing
-
-#### Global
+## Path Forward
 
-- Geary class
-- GetisOrd class
+Summaries of milestones for v1.x and v2.0. These lists are subject to change. If you have an additional feature you want to see for either milestone, open up an issue or PR.
 
-#### Local
+### v1.x
 
-- Join Count Statistic
+1. Global Measurements
+   - `Geary`'s C
+   - `GetisOrd`
+2. Local Measurements
+   - `Join Count`
+3. Utilities
+   - Add support for .gal/.swm file imports
+   - Add support for Rate variables
+   - Add support for Bayes smoothing
+4. General
+   - Point Pattern Analysis Module
+   - Regression Module
 
-#### PPA
+### v2.0
 
-- Add descriptive stat methods for point clusters.
+- Break gem into core `spatial_stats` that will not include queries module and `spatial_stats-activerecord`. This will remove the dependency on rails for the core gem.
+- Create `spatial_stats-import/geojson/shp` gem that will allow importing files and generating a `WeightsMatrix`. Will likely rely on `RGeo` or another spatial lib.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause).

data/ext/spatial_stats/csr_matrix.c

@@ -111,23 +111,19 @@ void mat_to_sparse(csr_matrix *csr, VALUE data, VALUE keys, VALUE num_rows)
 
 /**
  *  A new instance of CSRMatrix.
- *  Uses a 1-D representation of a 2-D array as input.
+ *  Uses a Dictionary of Keys (DOK) as input to represent a square matrix.
  *  @example
- *      dummy_data = [
- *                      [0, 1, 2]
- *                      [3, 4, 5],
- *                      [6, 7, 8]   
- *                   ]
+ *      weights = {
+ *          'a' => [{ id: 'c', weight: 1 }],
+ *          'b' => [{ id: 'b', weight: 1 }],
+ *          'c' => [{ id: 'a', weight: 1 }]
+ *      }
  *      num_rows = 3
- *      num_cols = 3
- *      data = dummy_data.flatten
- *      # => [0, 1, 2, 3, 4, 5, 6, 7, 8]
  *      
- *      csr = CSRMatrix.new(data, num_rows, num_cols)
+ *      csr = CSRMatrix.new(data, num_rows)
  * 
  *  @param [Array] data in 1-D format
  *  @param [Integer] num_rows in the 2-D representation
- *  @param [Integer] num_cols in the 2-D representation
  *  
  *  @return [CSRMatrix]
  */

data/lib/spatial_stats/global/bivariate_moran.rb

@@ -21,7 +21,6 @@ module SpatialStats
         @y_field = y_field
         @weights = weights.standardize
       end
-      attr_writer :x, :y
 
       ##
       # Computes the global spatial correlation of x against spatially lagged

data/lib/spatial_stats/global/moran.rb

@@ -18,7 +18,6 @@ module SpatialStats
       def initialize(scope, field, weights)
         super(scope, field, weights)
       end
-      attr_writer :x
 
       ##
       # Computes the global spatial autocorrelation of x against a spatially

data/lib/spatial_stats/global/stat.rb

@@ -39,6 +39,15 @@ module SpatialStats
         (stat - expectation) / Math.sqrt(variance)
       end
 
+      def x=(values)
+        @x = values.standardize
+      end
+      alias z= x=
+
+      def y=(values)
+        @y = values.standardize
+      end
+
       def mc(permutations, seed)
         rng = gen_rng(seed)
         shuffles = []

data/lib/spatial_stats/local/bivariate_moran.rb

@@ -22,7 +22,6 @@ module SpatialStats
         @weights = weights.standardize
       end
       attr_accessor :scope, :x_field, :y_field, :weights
-      attr_writer :x, :y
 
       ##
       # Computes the local indicator of spatial correlation for

data/lib/spatial_stats/local/geary.rb

@@ -18,7 +18,6 @@ module SpatialStats
       def initialize(scope, field, weights)
         super(scope, field, weights)
       end
-      attr_writer :x
 
       ##
       # Computes Geary's C for every observation in the +scoe+.

data/lib/spatial_stats/local/moran.rb

@@ -20,7 +20,6 @@ module SpatialStats
       def initialize(scope, field, weights)
         super(scope, field, weights)
       end
-      attr_writer :x
 
       ##
       # Computes the local indicator of spatial autocorrelation (lisa) for

data/lib/spatial_stats/local/stat.rb

@@ -28,6 +28,15 @@ module SpatialStats
         raise NotImplementedError, 'method variance not implemented'
       end
 
+      def x=(values)
+        @x = values.standardize
+      end
+      alias z= x=
+
+      def y=(values)
+        @y = values.standardize
+      end
+
       ##
       # Z-score for each observation of the statistic.
       #

data/lib/spatial_stats/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpatialStats
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spatial_stats
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Keith Doggett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -127,13 +127,12 @@ description: An ActiveRecord/PostGIS extension that provides statistical methods
   weighting in PostGIS and performs statistical computations inside your rails app.
   Supports contiguious and distance-based calculations.
 email:
-- keith.doggett887@gmail.com
+- kfdoggett@gmail.com
 executables: []
 extensions:
 - ext/spatial_stats/extconf.rb
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - ext/spatial_stats/csr_matrix.c
@@ -169,11 +168,12 @@ files:
 - lib/tasks/spatial_stats_tasks.rake
 homepage: https://www.github.com/keithdoggett/spatial_stats
 licenses:
-- MIT
+- BSD-3-Clause
 metadata:
   homepage_uri: https://www.github.com/keithdoggett/spatial_stats
   source_code_uri: https://www.github.com/keithdoggett/spatial_stats
   documentation_uri: https://keithdoggett.github.io/spatial_stats/
+  changelog_uri: https://www.github.com/keithdoggett/spatial_stats/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2020 Keith Doggett
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.