{"id":16971598,"url":"https://github.com/johncoene/base-gior","last_synced_at":"2025-03-21T20:16:20.724Z","repository":{"id":85365954,"uuid":"152600181","full_name":"JohnCoene/base-gior","owner":"JohnCoene","description":"Setup to start building the gior package","archived":false,"fork":false,"pushed_at":"2021-03-01T20:27:28.000Z","size":945,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-26T14:48:37.993Z","etag":null,"topics":["htmlwidgets","r","tutorial","visualization"],"latest_commit_sha":null,"homepage":"","language":"R","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/JohnCoene.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-11T13:55:12.000Z","updated_at":"2021-03-01T20:27:31.000Z","dependencies_parsed_at":"2023-07-01T18:30:38.072Z","dependency_job_id":null,"html_url":"https://github.com/JohnCoene/base-gior","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/JohnCoene%2Fbase-gior","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fbase-gior/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fbase-gior/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fbase-gior/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JohnCoene","download_url":"https://codeload.github.com/JohnCoene/base-gior/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244860611,"owners_count":20522466,"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":["htmlwidgets","r","tutorial","visualization"],"created_at":"2024-10-14T00:52:52.577Z","updated_at":"2025-03-21T20:16:20.705Z","avatar_url":"https://github.com/JohnCoene.png","language":"R","readme":"# gior-base\n\nThis is the base of `gior` for you to easily follow along the [how to build htmlwidgets blogpost](https://blog.john-coene.com/posts/2018-01-01-widget/) and build the htmlwidget for [gio.js](http://giojs.org/index.html) yourself!\n\n1. [Get Started](#get-started)\n2. [Historic](#historic)\n3. [Changes](#changes)\n4. [Data](#data)\n5. [Package](#package)\n\n## Get Started\n\nClone this [repository](https://github.com/JohnCoene/base-gior) with `git clone https://github.com/JohnCoene/base-gior.git`, or, from [RStudio](https://www.rstudio.com/):\n\n1. go to `File`\n2. Click on `New Project`\n3. Select `Version Control`\n4. Then select `Git`\n5. And paste the URL (`https://github.com/JohnCoene/base-gior.git`) under `Repository URL`\n6. Finally, click `Create Project`.\n\n## Historic\n\nHere are the only functions that were ran:\n\n1. `devtools::create(\"gior\")`\n2. `htmlwiidgets::scaffoldWidget(\"gior\")`\n\nEssentially creating a package with `devtools` and scaffolding the htmlwidget from the root of the package. You should be familiar with the first function. The second function essentially builds the following:\n\n```\nR/\n| gior.R\n\ninst/\n|-- htmlwidgets/\n|   |-- gior.js\n|   |-- gior.yaml\n```\n\n## Changes\n\nSimply for convenience and for one to quickly get on with building the widget, some files were already edited or added.\n\n### DESCRIPTION\n\nEdited some meta information that you should change and added necessary `Imports`:\n\n1. `htmlwidgets`\n2. `shiny`\n3. `jsonlite`\n\n### YML\n\nThe `gior.yml` file located in the `inst` folder was edited from:\n\n```yml\n# (uncomment to add a dependency)\n# dependencies:\n#  - name:\n#    version:\n#    src:\n#    script:\n#    stylesheet:\n```\n\nto\n\n```yml\ndependencies:\n - name: three\n   version: 97\n   src: htmlwidgets/lib/three\n   script: three.min.js\n - name: gio\n   version: 2.0\n   src: htmlwidgets/lib/gio-2.0\n   script: gio.min.js\n```\n\n*The [blogpost](https://john-coene.com/post/how-to-build-htmlwidgets/) explains what this file does.*\n\n### lib\n\nThe `lib` directory (and its sub directories); we essentially added the dependencies (that are referred to in the *YML section* above)\n\n```\nR/\n| gior.R\n\ninst/\n|-- htmlwidgets/\n|   |-- gior.js\n|   |-- gior.yaml\n|   |-- lib/\n|   |   |-- gio-2.0/\n|   |   |   |-- gio.min.js\n|   |   |-- three/\n|   |   |   |-- three.min.js\n```\n\n## Data\n\nThe package also includes random data for you to test your package which can be loaded with `data(\"country_data\")`.\n\n## Package\n\nThis is a package, remember that to see changes reflected you will have to run:\n\n1. `devtools::document()`\n2. Then`devtools::install()` or `CTRL/CMD + SHIFT + B` from RStudio.\n\n**Note that, as is, the package works but does not pass `R CMD Check`.**\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohncoene%2Fbase-gior","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohncoene%2Fbase-gior","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohncoene%2Fbase-gior/lists"}