{"id":16472819,"url":"https://github.com/christopherkenny/planscorer","last_synced_at":"2025-10-27T14:31:03.820Z","repository":{"id":128694755,"uuid":"569551565","full_name":"christopherkenny/planscorer","owner":"christopherkenny","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-25T14:33:56.000Z","size":6535,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-26T01:39:51.372Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://christophertkenny.com/planscorer/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/christopherkenny.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-11-23T04:39:30.000Z","updated_at":"2024-09-25T14:29:33.000Z","dependencies_parsed_at":"2024-02-26T22:50:24.733Z","dependency_job_id":"3d0a1c9e-09ba-4828-9969-0b381193e6fb","html_url":"https://github.com/christopherkenny/planscorer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fplanscorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fplanscorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fplanscorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fplanscorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christopherkenny","download_url":"https://codeload.github.com/christopherkenny/planscorer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219861083,"owners_count":16556007,"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":[],"created_at":"2024-10-11T12:18:38.909Z","updated_at":"2025-10-27T14:31:03.815Z","avatar_url":"https://github.com/christopherkenny.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = '#\u003e',\n  fig.path = 'man/figures/README-',\n  out.width = '100%'\n)\n```\n\n# planscorer \u003ca href=\"http://christophertkenny.com/planscorer/\"\u003e\u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"138\" /\u003e\u003c/a\u003e\n\n\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/christopherkenny/planscorer/workflows/R-CMD-check/badge.svg)](https://github.com/christopherkenny/planscorer/actions)\n[![planscorer status badge](https://christopherkenny.r-universe.dev/badges/planscorer)](https://christopherkenny.r-universe.dev/planscorer)\n[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)\n[![CRAN status](https://www.r-pkg.org/badges/version/planscorer)](https://CRAN.R-project.org/package=planscorer)\n![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/planscorer)\n\u003c!-- badges: end --\u003e\n\n`planscorer` offers an R interface to PlanScore.org's API.\n\n## Installation\n\nYou can install the stable version of planscorer from CRAN with:\n\n``` r\ninstall.packages('planscorer')\n```\n\nYou can install the development version of planscorer from [GitHub](https://github.com/) with:\n\n``` r\n# install.packages('remotes')\nremotes::install_github('christopherkenny/planscorer')\n```\n\n## Authentication\n\nTo use planscorer, you must have an API key from PlanScore. Otherwise, you will get a 403 forbidden error.\n\nTo get a key, follow the [instructions here](https://github.com/PlanScore/PlanScore/blob/main/API.md).\n\nOnce you have a key, use `ps_set_key('your_key')`. Optionally use `ps_set_key('your_key', install = TRUE)` to allow your key to be available across sessions.\n\n## Example\n\nWith a file, you can upload using the `ps_upload_file()` option:\n\n```{r example}\nlibrary(planscorer)\n## basic example code\n\nfile \u003c- system.file('extdata/null-plan-incumbency.geojson', package = 'planscorer')\nlinks \u003c- ps_upload_file(file)\n```\n\n```{r, echo=FALSE}\nSys.sleep(20)\n```\n\n\nTo read the data results:\n\n```{r}\nps_ingest(links)\n```\n\nTo capture the outputted figures on the site:\n\n```{r}\nimg \u003c- 'man/figures/README-planscore.png'\nps_capture(links, img)\n\nknitr::include_graphics(img)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherkenny%2Fplanscorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristopherkenny%2Fplanscorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherkenny%2Fplanscorer/lists"}