{"id":19440386,"url":"https://github.com/devinit/r-fts","last_synced_at":"2025-04-24T22:33:35.963Z","repository":{"id":50148182,"uuid":"166045332","full_name":"devinit/r-fts","owner":"devinit","description":"FTS API Plugin for R","archived":false,"fork":false,"pushed_at":"2024-07-31T12:59:42.000Z","size":44,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-07-31T15:35:52.523Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devinit.png","metadata":{"files":{"readme":"README.md","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,"publiccode":null,"codemeta":null}},"created_at":"2019-01-16T13:31:34.000Z","updated_at":"2024-07-31T15:35:55.013Z","dependencies_parsed_at":"2023-12-06T18:44:07.480Z","dependency_job_id":null,"html_url":"https://github.com/devinit/r-fts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinit%2Fr-fts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinit%2Fr-fts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinit%2Fr-fts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devinit%2Fr-fts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devinit","download_url":"https://codeload.github.com/devinit/r-fts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223971544,"owners_count":17234077,"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-11-10T15:29:11.450Z","updated_at":"2024-11-10T15:29:12.071Z","avatar_url":"https://github.com/devinit.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# r-fts\nFTS API Plugin for R\n\n### Authentication\nIf you have an FTS API username and password, create an `auth` list object like so:\n\n```\nauth = list(\n  \"user\"=\"YourUserNameHere\",\n  \"pass\"=\"YourPasswordHere\"\n)\n```\n\nThis object can then be passed to any of the R-FTS functions like so:\n\n```\n# Without named params\nproj = fts.proj.by.id(1,auth)\n# With named params\nproj = fts.proj.by.id(id=1,auth=auth)\n```\n\n### Examples of use\n```\n# Place r-fts.R in your working directory. You can then load the functions:\nsource(\"r-fts.R\")\n\n# Alternatively, source the code straight from Github\nsource(\"https://raw.githubusercontent.com/devinit/r-fts/master/r-fts.R\")\n\n# Returns report1, report2, report3, and report4 as lists\n# Each list has attributes data, and meta\ntest.flow.group = fts.flow(\n  boundary=\"year=2015\",\n  filterBy=c(\"destinationGlobalClusterCode:HEA\",\"destinationLocationID:114,115\"),\n  groupBy=\"organization\"\n)\n\n# Without groupBy, the structure changes quite dramatically\n# This will return incoming, outgoing, internal, and flows\ntest.flow = fts.flow(\n  boundary=\"year=2015\",\n  filterBy=c(\"destinationGlobalClusterCode:HEA\",\"destinationLocationID:114,115\")\n)\n\ntest.cluster = fts.cluster()\n\ntest.locat = fts.locat()\n\ntest.org = fts.org()\n\ntest.proj.code = fts.proj.by.code(\"MM-15/H/75359/6491\")\n\ntest.proj.id = fts.proj.by.id(1)\n\ntest.proj.plan.id = fts.proj.by.plan.id(34)\n\ntest.proj.plan.code = fts.proj.by.plan.code(\"HSDN14\")\n\ntest.emergency.id = fts.emergency.id(611)\n\ntest.emergency.year = fts.emergency.year(2013)\n\ntest.emergency.iso3 = fts.emergency.iso3(\"SDN\")\n\ntest.plan.id = fts.plan.id(34)\n\ntest.plan.code = fts.plan.code(\"HAFG16\")\nnames(test.plan.code)\n\ntest.plan.year = fts.plan.year(2013)\n\ntest.plan.iso3 = fts.plan.iso3(\"SDN\")\n```\n\n### Further documentation\nFurther documentation can be found at the source API here:\n\nhttps://api.hpc.tools/docs/v1/\n\n### Disclaimer\nDevelopment Initiatives Poverty Research, Ltd. does not own any of the data returned by this API. Data is owned by UNOCHA, and access to the data is determined through their terms and conditions.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevinit%2Fr-fts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevinit%2Fr-fts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevinit%2Fr-fts/lists"}