{"id":14977124,"url":"https://github.com/irkernel/irkernel","last_synced_at":"2025-05-15T09:09:19.915Z","repository":{"id":14484288,"uuid":"17196838","full_name":"IRkernel/IRkernel","owner":"IRkernel","description":"R kernel for Jupyter","archived":false,"fork":false,"pushed_at":"2024-04-30T07:24:08.000Z","size":786,"stargazers_count":1674,"open_issues_count":72,"forks_count":299,"subscribers_count":61,"default_branch":"master","last_synced_at":"2025-05-15T09:09:13.006Z","etag":null,"topics":["jupyter","jupyter-kernels","jupyter-notebook","r","zmq"],"latest_commit_sha":null,"homepage":"https://irkernel.github.io/","language":"Jupyter Notebook","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/IRkernel.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":"2014-02-26T02:57:07.000Z","updated_at":"2025-05-06T06:40:50.000Z","dependencies_parsed_at":"2024-04-29T17:28:34.973Z","dependency_job_id":"fa90f108-32cb-4501-a591-93386ed9f220","html_url":"https://github.com/IRkernel/IRkernel","commit_stats":{"total_commits":523,"total_committers":48,"mean_commits":"10.895833333333334","dds":0.4550669216061185,"last_synced_commit":"1eddb304b246c14b62949abd946e8d4ca5080d25"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IRkernel%2FIRkernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IRkernel%2FIRkernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IRkernel%2FIRkernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IRkernel%2FIRkernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IRkernel","download_url":"https://codeload.github.com/IRkernel/IRkernel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310520,"owners_count":22049470,"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":["jupyter","jupyter-kernels","jupyter-notebook","r","zmq"],"created_at":"2024-09-24T13:55:08.471Z","updated_at":"2025-05-15T09:09:14.908Z","avatar_url":"https://github.com/IRkernel.png","language":"Jupyter Notebook","readme":"# Native R kernel for Jupyter [![b-CI]][CI] [![b-CRAN]][CRAN]\n\n[b-CI]: https://github.com/IRkernel/IRkernel/actions/workflows/r.yml/badge.svg \"Build status\"\n[CI]: https://github.com/IRkernel/IRkernel/actions/workflows/r.yml\n[b-CRAN]: https://www.r-pkg.org/badges/version/IRkernel \"Comprehensive R Archive Network\"\n[CRAN]: https://cran.r-project.org/package=IRkernel\n\nFor detailed requirements and install instructions see [irkernel.github.io](https://irkernel.github.io/)\n\n## Requirements\n\n* [Jupyter](https://jupyter.org).\n* A current [R installation](https://www.R-project.org).\n\n## Installation\n\nThis package is available on CRAN:\n\n```R\ninstall.packages('IRkernel')\nIRkernel::installspec()  # to register the kernel in the current R installation\njupyter labextension install @techrah/text-shortcuts  # for RStudio’s shortcuts\n```\n\nPer default `IRkernel::installspec()` will install a kernel with the name “ir” and a\ndisplay name of “R”. Multiple calls will overwrite the kernel with a kernel spec pointing to the last\nR interpreter you called that commands from. You can install kernels for multiple versions of R\nby supplying a `name` and `displayname` argument to the `installspec()` call (You still need to\ninstall these packages in all interpreters you want to run as a jupyter kernel!):\n\n```r\n# in R 3.3\nIRkernel::installspec(name = 'ir33', displayname = 'R 3.3')\n# in R 3.2\nIRkernel::installspec(name = 'ir32', displayname = 'R 3.2')\n```\n\nBy default, it installs the kernel per-user.  To install system-wide,\nuse `user = FALSE`.  To install in the `sys.prefix` of the currently\ndetected `jupyter` command line utility, use `sys_prefix = TRUE`.\n\nNow both R versions are available as an R kernel in the notebook.\n\n### If you encounter problems during installation\n\n1. Have a look at the [full installation instructions](https://irkernel.github.io/installation/)!\n2. [Search the existing open and closed issues](https://github.com/IRkernel/IRkernel/issues?utf8=%E2%9C%93\u0026q=is%3Aissue).\n3. If you are sure that this is a new problem, [file an issue](https://github.com/IRkernel/IRkernel/issues/new).\n\n## Running the notebook\n\nIf you have Jupyter installed, you can create a notebook using IRkernel from the dropdown menu.\n\nYou can also start other interfaces with an R kernel:\n\n```bash\n# “ir” is the kernel name installed by the above `IRkernel::installspec()`\n# change if you used a different name!\njupyter qtconsole --kernel=ir\njupyter console --kernel=ir\n```\n\n## Run a stable release in a Docker container\n\nRefer to the [jupyter/docker-stacks r-notebook](https://github.com/jupyter/docker-stacks/tree/master/r-notebook) repository\n\nIf you have a Docker daemon running, e.g. reachable on localhost, start a container with:\n\n```bash\ndocker run -d -p 8888:8888 jupyter/r-notebook\n```\n\nOpen localhost:8888 in your browser. All notebooks from your session will be saved in the current directory.\n\nOn other platforms without docker, this can be started using `docker-machine` by replacing “localhost” with an IP from `docker-machine ip \u003cMACHINE\u003e`. With the deprecated `boot2docker`, this IP will be `boot2docker ip`.\n\n## Develop and run from source in a Docker container\n\n```bash\nmake docker_dev_image #builds dev image and installs IRkernel dependencies from github\nmake docker_dev #mounts source, installs, and runs Jupyter notebook; docker_dev_image is a prerequisite\nmake docker_test #builds the package from source then runs the tests via R CMD check; docker_dev_image is a prerequisite\n```\n\n## How does it know where to install?\n\nThe IRKernel does not have any Python dependencies whatsoever, and\ndoes not know anything about any other Jupyter/Python installations\nyou may have.  It only requires the `jupyter` command to be available\non `$PATH`.  To install the kernel, it prepares a kernelspec directory\n(containing `kernel.json` and so on), and passes it to the command\nline `jupyter kernelspec install [options] prepared_kernel_dir/`,\nwhere options such as `--name`, `--user`, `--prefix`, and\n`--sys-prefix` are given based on the options.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firkernel%2Firkernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firkernel%2Firkernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firkernel%2Firkernel/lists"}