pfms

Participatory Factor Mapping

Usage no npm install needed!

<script type="module">
  import pfms from 'https://cdn.skypack.dev/pfms';
</script>

README

Welcome to Participatory Factor Mapping Software (PFMS) 👋

Version Documentation Maintenance

This is a library which can be used to simplify the process of Participatory Factor Mapping. To collect data and create a map of community factors, assets, or resources in a defined area. Then use this map to pinpoint the relationships between such factors and their influence on one another.

🏠 Homepage

Demo

Install

npm install pfms

Examples

load()

/**
 * Loads Array from CSV formmatted string
 * @param {String} theData a csv file represented as a string
 * @returns a 2D array of integers which hold the data and location in the array
 * and a list of the factors
 */
//Example
let array = PFMS.load(string)
console.log(indirect)

sum()

/**
 * Function used to add every value of a 2D Array
 * @param {Integer [][]} theArray A 2D Array of integers
 * @returns The summation of every value
 */
//Example
let total = PFMS.sum(array)
console.log(total)

iterate()

/**
 * Takes in a 2D array of integers and then multiplies on it self
 * the number of times the iterator is set to.
 * @param {Integer [][]} theArray A 2D array of integer
 * @param {Integer} theIterator The number of times to iterate
 * @returns A 2D array of the multiplied over itself
 */
//Example
let indirect = PFMS.multiply(array,2)
console.log(indirect)

Author

👤 Bryce Fujita bfujita@uw.edu (https://github.com/bryce-fujita/PFMSLibrary)

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Bryce Fujita bfujita@uw.edu (https://github.com/bryce-fujita/PFMSLibrary).
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator