{"id":13586782,"url":"https://github.com/ropensci-archive/rorcid","last_synced_at":"2025-04-07T18:34:52.888Z","repository":{"id":5332099,"uuid":"6517373","full_name":"ropensci-archive/rorcid","owner":"ropensci-archive","description":":warning: ARCHIVED :warning: A programmatic interface the Orcid.org API","archived":false,"fork":false,"pushed_at":"2024-05-06T18:09:43.000Z","size":3976,"stargazers_count":110,"open_issues_count":0,"forks_count":14,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-06-11T18:22:13.476Z","etag":null,"topics":["api-wrapper","doi","identifiers","orcid","orcid-api","r","r-package","rstats","scholarly-metadata"],"latest_commit_sha":null,"homepage":"","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/ropensci-archive.png","metadata":{"files":{"readme":"README-not.md","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","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":"codemeta.json"}},"created_at":"2012-11-03T07:35:54.000Z","updated_at":"2024-08-01T16:32:51.718Z","dependencies_parsed_at":"2024-08-01T16:42:48.752Z","dependency_job_id":null,"html_url":"https://github.com/ropensci-archive/rorcid","commit_stats":null,"previous_names":["ropensci/rorcid"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Frorcid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Frorcid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Frorcid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci-archive%2Frorcid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ropensci-archive","download_url":"https://codeload.github.com/ropensci-archive/rorcid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223290232,"owners_count":17120870,"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":["api-wrapper","doi","identifiers","orcid","orcid-api","r","r-package","rstats","scholarly-metadata"],"created_at":"2024-08-01T15:05:48.431Z","updated_at":"2024-11-06T05:30:40.760Z","avatar_url":"https://github.com/ropensci-archive.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"rorcid\n======\n\n\n\n\u003c!-- badges: start --\u003e\n[![R build status](https://github.com/ropensci/rorcid/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/rorcid/actions)\n[![cran checks](https://cranchecks.info/badges/worst/rorcid)](https://cranchecks.info/pkgs/rorcid)\n[![codecov.io](https://codecov.io/github/ropensci/rorcid/coverage.svg?branch=master)](https://codecov.io/github/ropensci/rorcid?branch=master)\n[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rorcid?color=2ED968)](https://github.com/r-hub/cranlogs.app)\n[![cran version](https://www.r-pkg.org/badges/version/rorcid)](https://cran.r-project.org/package=rorcid)\n\u003c!-- badges: end --\u003e\n\n`rorcid` is an R programmatic interface to the Orcid public API. `rorcid` is not a product developed or distributed by ORCID®.\n\nrorcid docs: \u003chttps://docs.ropensci.org/rorcid/\u003e\n\nOrcid API docs:\n\n* Public API docs: \u003chttps://members.orcid.org/api\u003e\n* Swagger docs: https://pub.orcid.org/v3.0/#/Development_Public_API_v3.0\n\nThe package now works with the `v3.0` ORCID API. It's too complicated to allow users to work with different versions of the API, so it's hard-coded to `v3.0`.\n\n## Authentication\n\nThere are three ways to authenticate with `rorcid`:\n\n- Interactively login with OAuth. This doesn't require any input on\nyour part. We use a client id and client secret key to ping ORCID.org;\nat which point you log in with your username/password; then we get back\na token (same as the above option). We don't know your username or\npassword, only the token that we get back. We cache that token locally\nin a hidden file in whatever working directory you're in. If you delete\nthat file, or run the code from a new working directory, then we\nre-authorize.\n- Use a `client_id` and `client_secret` to do 2-legged OAuth. \nORCID docs at https://members.orcid.org/api/oauth/2legged-oauth and\nhttps://members.orcid.org/api/post-oauthtoken-reading-public-data\nThis requires you to register a \"client application\". See \nhttps://orcid.org/content/register-client-application-2 for instructions\n- Use a token as a result of either of the two above approaches. The token\nis a alphanumeric UUID, e.g. `dc0a6b6b-b4d4-4276-bc89-78c1e9ede56e`. You\ncan get this token by running `orcid_auth()`, then storing that key\n(the uuid alone, not the \"Bearer \" part) either as en environment\nvariable in your `.Renviron` file in your home directory (with the name\n`ORCID_TOKEN`), or as an R option in your `.Rprofile` file (with the name\n`orcid_token`). See [Startup] for more information.\nEither an environment variable or R option work. If we don't find\neither we do the next option.\n\nWe recommend the 3rd option if possible, specifically, storing the token\nas an environment variable permanently.\n\nIf authentication fails, you can still use `rorcid`. ORCID does not require\nauthentication at this point, but may in the future - this prepares you\nfor when that happens.\n\nSee \u003chttps://info.orcid.org/documentation/integration-guide/getting-started-with-your-orcid-integration/#easy-faq-2569\u003e for more about ORCID \nOAuth Scopes.\n\n## Computing environments without browsers\n\nOne pitfall is when you are using `rorcid` on a server, and you're ssh'ed\nin, so that there's no way to open a browser to do the OAuth browser\nflow. Similarly for any other situation in which a browser can not be\nopened. In this case, run `orcid_auth()` on another machine in which you do\nhave the ability to open a browser, then collect the info that's ouptput\nfrom `orcid_auth()` and store it as an environment variable (see above).\n\n## Installation\n\nStable version\n\n\n```r\ninstall.packages(\"rorcid\")\n```\n\nDevelopment version\n\n\n```r\nremotes::install_github(\"ropensci/rorcid\")\n```\n\n\n```r\nlibrary('rorcid')\n```\n\n## Docs\n\nGet started with rorcid at \u003chttps://docs.ropensci.org/rorcid/\u003e\n\n## Meta\n\n* Please [report any issues or bugs](https://github.com/ropensci/rorcid/issues)\n* License: MIT\n* Get citation information for `rorcid` in R doing `citation(package = 'rorcid')`\n* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-archive%2Frorcid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropensci-archive%2Frorcid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci-archive%2Frorcid/lists"}