Exploring patterns as a means of understanding and documenting functions.
Clojure
Latest commit bbbef83 Feb 10, 2017 @josephwilk new examples
Permalink
Failed to load latest commit information.
doc
src/functions_as_patterns
.gitignore
README.md
project.clj

README.md

Functions as patterns 🌈

Exploring patterns as a means of understanding and documenting functions.

Inspired by the work of Alex McLean (@yaxu) using visual patterns to explain the live coding language Tidal: Tidal Pattern Language for Live Coding of Music

Install:

Add to your project.clj file:

[functions-as-patterns "0.1.0-SNAPSHOT"]

Example:

(require 'functions-as-patterns.core :refer :all)

(view-as-colors 
  (partition 3 (range 10)))

(view-as-colors
  (partition-all 3 (range 10))))

(partition 3 Argument)

;;=> Result

(partition-all 3 Argument)

;;=> Result

Api:

;;Render to file, assume arguments are colors
(render "/tmp/" (partition 2 (hues 10)))

;;Render to file, convert arguments to colors
(render-as-colors "/tmp/" (partition 2 (range 10)))

;;Render assuming arguments are colors
(view (partition 2 (hues 10)))

;;Render mapping arguments to colors
(view-as-colors (partition 2 (range 10)))

License

Copyright © 2017-present Joseph Wilk

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.

For full license information, see the LICENSE file.