{"id":13591528,"url":"https://github.com/workflowr/workflowr","last_synced_at":"2025-05-14T02:08:21.467Z","repository":{"id":41125900,"uuid":"75893305","full_name":"workflowr/workflowr","owner":"workflowr","description":"Organize your project into a research website","archived":false,"fork":false,"pushed_at":"2025-04-30T15:42:28.000Z","size":3443,"stargazers_count":852,"open_issues_count":41,"forks_count":106,"subscribers_count":29,"default_branch":"main","last_synced_at":"2025-04-30T16:38:40.913Z","etag":null,"topics":["git","project-management","r","rmarkdown","rstats","website","workflow"],"latest_commit_sha":null,"homepage":"https://workflowr.github.io/workflowr","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/workflowr.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2016-12-08T02:02:58.000Z","updated_at":"2025-04-30T15:40:47.000Z","dependencies_parsed_at":"2025-04-11T09:59:15.609Z","dependency_job_id":"08881bb3-9338-42db-af8a-283132aed0a4","html_url":"https://github.com/workflowr/workflowr","commit_stats":{"total_commits":1243,"total_committers":22,"mean_commits":56.5,"dds":0.084473049074819,"last_synced_commit":"79a96d49b27187f9353581fda6ff6d900c2bb42c"},"previous_names":["jdblischak/workflowr"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workflowr%2Fworkflowr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workflowr%2Fworkflowr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workflowr%2Fworkflowr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workflowr%2Fworkflowr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workflowr","download_url":"https://codeload.github.com/workflowr/workflowr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254053152,"owners_count":22006717,"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":["git","project-management","r","rmarkdown","rstats","website","workflow"],"created_at":"2024-08-01T16:00:58.671Z","updated_at":"2025-05-14T02:08:16.453Z","avatar_url":"https://github.com/workflowr.png","language":"R","funding_links":[],"categories":["R","Uncategorized","其他_机器学习与深度学习"],"sub_categories":["Uncategorized"],"readme":"# workflowr: organized + reproducible + shareable data science in R\n\n[![CRAN status](https://www.r-pkg.org/badges/version/workflowr)](https://cran.r-project.org/package=workflowr)\n[![CRAN downloads](https://cranlogs.r-pkg.org/badges/workflowr)](https://cran.r-project.org/package=workflowr)\n[![DOI](https://zenodo.org/badge/75893305.svg)](https://zenodo.org/badge/latestdoi/75893305)\n[![build](https://github.com/workflowr/workflowr/workflows/build/badge.svg)](https://github.com/workflowr/workflowr/actions/workflows/build.yaml)\n[![codecov](https://codecov.io/gh/workflowr/workflowr/branch/main/graphs/badge.svg?branch=main)](https://app.codecov.io/gh/workflowr/workflowr)\n\n\u003cimg src=\"https://raw.githubusercontent.com/workflowr/workflowr-assets/main/img/hex-workflowr.png\" alt=\"hex sticker for workflowr R package\" align=\"right\" width=\"100px\"\u003e\n\nThe workflowr R package helps researchers organize their analyses in a way that\npromotes effective project management, reproducibility, collaboration, and\nsharing of results. Workflowr combines literate programming (knitr and\nrmarkdown) and version control (Git, via git2r) to generate a website containing\ntime-stamped, versioned, and documented results. Any R user can quickly and\neasily adopt workflowr.\n\nFor more details, see the [online documentation][workflowr-docs]. For an\nexample, see the [Divvy data exploration project][divvy]. To explore\nreproducible research projects facilitated by workflowr, browse the projects\nregistered at [workflowr.io][]. To keep up-to-date with the latest workflowr\ndevelopments, please join the [workflowr-announce][] mailing list (low-volume,\nread-only). For bugs reports, feature requests, and questions, please open an\n[Issue][issues].\n\n[workflowr.io]: https://workflowr.io/\n[workflowr-announce]: https://groups.google.com/forum/#!forum/workflowr-announce\n\n* [Features](#features)\n* [Installation](#installation)\n* [Quick start](#quick-start)\n* [Attribution](#attribution)\n* [Contributing](#contributing)\n\n## Features\n\n* Organized\n    * Provides a project template with organized subdirectories\n    * Mixes code and results with R Markdown\n    * Uses Git to version both source code and results\n* Reproducible\n    * Displays the code version used to create each result\n    * Runs each analysis in an isolated R session\n    * Records the session information of each analysis\n    * Sets the same seed for random number generation for each analysis\n* Shareable\n    * Creates a website to present your research results\n    * Documents how to host your website for free via [GitHub Pages][] or\n    [GitLab Pages][]\n    * Creates links to past versions of results\n\nTo see a workflowr website in action, see this [video demonstration][video].\n\nFor related tools, see [r-project-workflows][].\n\n## Installation\n\n1. Install [R][r]\n\n    * (Recommended) Install [RStudio][rstudio]\n\n    * (Optional) Install [pandoc][] ([Instructions][pandoc-install])\n\n    * (Optional) Install [Git][git]\n\n1. Install workflowr from [CRAN][cran]:\n\n    ```r\n    install.packages(\"workflowr\")\n    ```\n\n1. Create an account on [GitHub][gh] or [GitLab][gl]\n\n## Quick start\n\n```\nlibrary(\"workflowr\")\n\n# Configure Git (only need to do once per computer)\nwflow_git_config(user.name = \"Full Name\", user.email = \"email@domain\")\n\n# Start a new workflowr project\nwflow_start(\"myproject\")\n\n# Build the site\nwflow_build()\n\n# Customize your site!\n#   1. Edit the R Markdown files in analysis/\n#   2. Edit the theme and layout in analysis/_site.yml\n#   3. Add new or copy existing R Markdown files to analysis/\n\n# Preview your changes\nwflow_build()\n\n# Publish the site, i.e. version the source code and HTML results\nwflow_publish(\"analysis/*\", \"Start my new project\")\n```\n\n**Next steps:**\n\n1. Read the full [Getting started vignette][vig-start] to learn how to share\nyour results online. Alternatively, you could read the [Reproducible research\nworkshop vignette][vig-workshop]. It covers the same steps, but includes example\ncode and data to demonstrate some of workflowr's reproducibility features\n\n1. Read the [customization vignette][vig-custom] for ideas on how to customize\nyour research website\n\n1. Read the [migrating vignette][vig-migrating] for how to integrate workflowr\ninto your existing project\n\n## Attribution\n\nWorkflowr was developed, and is maintained, by John Blischak, a postdoctoral\nresearcher in the laboratory of [Matthew Stephens][stephens] at [The University\nof Chicago][uchicago]. He is funded by a grant from the [Gordon and Betty Moore\nFoundation][moore] to MS. [Peter Carbonetto][pcarbo] and [Matthew\nStephens][stephens] are co-authors.\n\nWe are very thankful to workflowr [contributors][] for helping improve the\npackage. We are also grateful for workflowr users for testing the package and\nproviding feedback---thanks especially to [Lei Sun][lsun], [Xiang\nZhu][xiangzhu], [Wei Wang][nkweiwang], and other members (past and present) of\nthe Stephens lab.\n\nThe workflowr package uses many great open source packages. Especially critical\nfor this project are the R packages [git2r][], [knitr][], and [rmarkdown][].\nPlease see the vignette [How the workflowr package works][vig-details] to learn\nabout the software that makes workflowr possible.\n\nWorkflowr is available under the [MIT license][MIT]. For proper attribution,\nplease cite our [manuscript][workflowr-paper] that describes the software:\n\n\u003e Blischak JD, Carbonetto P, and Stephens M. Creating and sharing reproducible\n\u003e research code the workflowr way [version 1; peer review: 3 approved].\n\u003e F1000Research 2019, 8:1749 (https://doi.org/10.12688/f1000research.20843.1)\n\nTo obtain a BibTeX entry, please run `citation(\"workflowr\")`. Note that\nF1000Research publishes not only the original version but also any revisions. To\ncheck for the latest version, please go to the paper's [URL][workflowr-paper].\n\n## Contributing\n\nWe welcome community contributions, especially improvements to documentation. To\nget started, please read the [contributing guidelines](CONTRIBUTING.md).\nAlso, please note that this project is released with a [Contributor Code of\nConduct](CODE_OF_CONDUCT.md). By participating in this project you agree to\nabide by its terms.\n\n[contributors]: https://github.com/workflowr/workflowr/graphs/contributors\n[cran]: https://cran.r-project.org/package=workflowr\n[divvy]: https://stephenslab.github.io/wflow-divvy/\n[gh]: https://github.com\n[gl]: https://about.gitlab.com/\n[git]: https://git-scm.com/\n[git2r]: https://cran.r-project.org/package=git2r\n[GitHub Pages]: https://pages.github.com/\n[GitLab Pages]: https://about.gitlab.com/stages-devops-lifecycle/pages/\n[issues]: https://github.com/workflowr/workflowr/issues\n[knitr]: https://github.com/yihui/knitr\n[lsun]: https://github.com/LSun\n[MIT]: https://opensource.org/licenses/mit-license.php\n[moore]: https://www.moore.org/\n[nkweiwang]: https://github.com/NKweiwang\n[pandoc]: https://pandoc.org/\n[pandoc-install]: https://pandoc.org/installing.html\n[pcarbo]: https://pcarbo.github.io/\n[r]: https://cran.r-project.org\n[rmarkdown]: https://rmarkdown.rstudio.com/\n[r-project-workflows]: https://github.com/jdblischak/r-project-workflows#readme\n[rstudio]: https://posit.co/download/rstudio-desktop/\n[stephens]: https://stephenslab.uchicago.edu/\n[uchicago]: https://www.uchicago.edu/\n[video]: https://www.youtube.com/watch?v=O1wv94sZfvE\n[vig-custom]: https://workflowr.github.io/workflowr/articles/wflow-02-customization.html\n[vig-details]: https://workflowr.github.io/workflowr/articles/wflow-04-how-it-works.html\n[vig-migrating]: https://workflowr.github.io/workflowr/articles/wflow-03-migrating.html\n[vig-start]: https://workflowr.github.io/workflowr/articles/wflow-01-getting-started.html\n[vig-workshop]: https://workflowr.github.io/workflowr/articles/wflow-09-workshop.html\n[workflowr-docs]: https://workflowr.github.io/workflowr/\n[workflowr-paper]: https://doi.org/10.12688/f1000research.20843.1\n[xiangzhu]: https://github.com/xiangzhu\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkflowr%2Fworkflowr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkflowr%2Fworkflowr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkflowr%2Fworkflowr/lists"}