{"id":26937428,"url":"https://github.com/predictiveecology/spades-modules","last_synced_at":"2026-01-27T20:41:17.283Z","repository":{"id":25673347,"uuid":"29109249","full_name":"PredictiveEcology/SpaDES-modules","owner":"PredictiveEcology","description":"A collection of available modules for use with the 'SpaDES' R package.","archived":false,"fork":false,"pushed_at":"2023-01-11T00:21:23.000Z","size":122457,"stargazers_count":10,"open_issues_count":10,"forks_count":10,"subscribers_count":7,"default_branch":"master","last_synced_at":"2023-08-12T03:20:06.629Z","etag":null,"topics":["spades-modules"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PredictiveEcology.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-11T22:56:27.000Z","updated_at":"2022-08-15T19:35:44.000Z","dependencies_parsed_at":"2023-01-14T05:15:16.622Z","dependency_job_id":null,"html_url":"https://github.com/PredictiveEcology/SpaDES-modules","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PredictiveEcology%2FSpaDES-modules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PredictiveEcology%2FSpaDES-modules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PredictiveEcology%2FSpaDES-modules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PredictiveEcology%2FSpaDES-modules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PredictiveEcology","download_url":"https://codeload.github.com/PredictiveEcology/SpaDES-modules/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246819771,"owners_count":20839095,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["spades-modules"],"created_at":"2025-04-02T13:15:13.378Z","updated_at":"2026-01-27T20:41:17.243Z","avatar_url":"https://github.com/PredictiveEcology.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# SpaDES modules\n\nA collection of available modules for use with the `SpaDES` R package ([link](http://spades.predictiveecology.org/)).\n\n## Downloading modules from GitHub\n\nThe easiest way is to identify the original GitHub location of the module you want (e.g., `PredictiveEcology/Biomass_core`) to download and run this:\n\n```\n# Choose module and choose what folder to install it in. You will have to remember this folder.\n# Choice 1 -- Simple install\n# This is useful for most cases (e.g., don't want to clone the module via git)\n# Get the function \"getModule\"\nif (!require(\"Require\")) {install.packages(\"Require\"); library(Require)}\nRequire(\"PredictiveEcology/SpaDES.install\") # install/load this package\n\nmodulePath = \"modules\" # Create one path for all modules for a project\ngetModule('PredictiveEcology/Biomass_core', modulePath = modulePath) \ngetModule('PredictiveEcology/Biomass_regeneration', modulePath = modulePath) \n```\n\nOr, a user can get the module through git, which has the benefit of maintaining version control, but is for more advanced use.\n```\n# Choice 2 -- Git install\n# This has the advantage that your source code will be linked to the main source code\n# Use git command line or your favorite Git client and fork/clone it with:\ngit clone git@github.com:PredictiveEcology/Biomass_core\ngit clone git@github.com:PredictiveEcology/Biomass_regeneration\n```\n\n**Please see list of [currently known modules](https://github.com/PredictiveEcology/SpaDES-modules/wiki/Current-modules-in-development)**\n`\n\n## Downloading modules from this repository\n\nAnother way to use modules is to get them from this repository is using the built-in functionality in the `SpaDES` package:\n\n    library(SpaDES)\n    saveTo \u003c- \"~/SpaDES-modules\" # change this to suit your needs\n    downloadModule(name = \"moduleName\", path = saveTo)\n\nThis will download and unzip the module files in the directory specified by `saveTo`.\n\n## Example download -- Game of Life\n\n    #    # install.packages(\"SpaDES\")\n    library(SpaDES)\n    setPaths() # sets 4 paths that SpaDES uses to temporary locations\n    # setPaths(modulePath = \"~\") # can try non-temporary locations too to keep between R sessions\n    \n    moduleName \u003c- \"gameOfLife\"\n    downloadModule(moduleName) # downloads to getPaths()$modulePath\n    \n    modules \u003c- list(moduleName)\n    \n    ######################\n    ## Blinking\n    ######################\n    \n    X = c(10)\n    Y = c(10)\n    TYPE \u003c- \"blinker\" ## see below for other types\n    \n    parameters \u003c- list(\n      gameOfLife = list(X = X, Y = Y, initialType = TYPE)\n    )\n    times \u003c- list(start = 1, end = 30) # only run for 10 steps\n    \n    clearPlot()\n    dev() # creates new, faster window if in RStudio\n    mySim \u003c- simInitAndSpades(times = times, params = parameters, modules = modules)\n    \n    ######################\n    # Do random starts on bigger map\n    ######################\n    \n    X = c(100)\n    Y = c(100)\n    TYPE \u003c- NA ## random\n    \n    parameters \u003c- list(\n      gameOfLife = list(X = X, Y = Y, initialType = TYPE)\n    )\n    clearPlot()\n    mySim \u003c- simInitAndSpades(times = times, params = parameters, modules = modules)\n    ####################\n    ####################\n\n    \n#### Load documentation and source code\n\n    ####################\n    #  Load Documentation and Source Code\n    ####################\n    # Load the documentation .Rmd\n    file.edit(file.path(getPaths()$modulePath, moduleName, paste0(moduleName, \".Rmd\")))\n\n    # Load the module source code .R\n    file.edit(file.path(getPaths()$modulePath, moduleName, paste0(moduleName, \".R\")))\n                              \n\n\n## [Known modules (existing or in development)](https://github.com/PredictiveEcology/SpaDES-modules/wiki/Current-modules-in-development)\n\nFor a list of other modules currently in development, see [here](https://github.com/PredictiveEcology/SpaDES-modules/wiki/Current-modules-in-development).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpredictiveecology%2Fspades-modules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpredictiveecology%2Fspades-modules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpredictiveecology%2Fspades-modules/lists"}