{"id":13424140,"url":"https://github.com/humburg/reportmd","last_synced_at":"2025-03-20T01:31:10.288Z","repository":{"id":152268142,"uuid":"55021603","full_name":"humburg/reportmd","owner":"humburg","description":"Create multi-page HTML reports in R","archived":false,"fork":false,"pushed_at":"2017-06-25T12:31:24.000Z","size":3966,"stargazers_count":24,"open_issues_count":6,"forks_count":3,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-02-28T21:58:41.499Z","etag":null,"topics":["data-science","r","rmarkdown","rstudio"],"latest_commit_sha":null,"homepage":"https://humburg.github.io/reportmd/","language":"CSS","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/humburg.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":"2016-03-30T01:07:59.000Z","updated_at":"2024-12-30T10:23:22.000Z","dependencies_parsed_at":"2024-05-01T19:17:38.780Z","dependency_job_id":null,"html_url":"https://github.com/humburg/reportmd","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humburg%2Freportmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humburg%2Freportmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humburg%2Freportmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humburg%2Freportmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/humburg","download_url":"https://codeload.github.com/humburg/reportmd/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244033589,"owners_count":20386955,"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":["data-science","r","rmarkdown","rstudio"],"created_at":"2024-07-31T00:00:49.244Z","updated_at":"2025-03-20T01:31:09.848Z","avatar_url":"https://github.com/humburg.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"# ReportMD --- Writing Complex Scientific Reports in R\nRelease: [![Build Status](https://travis-ci.org/humburg/reportmd.svg?branch=master)](https://travis-ci.org/humburg/reportmd) \nDevelopment: [![Build Status](https://travis-ci.org/humburg/reportmd.svg?branch=develop)](https://travis-ci.org/humburg/reportmd) \n\nIt is common for complex analyses to be carried out in R. To improve the\nreproducability of such analyses and provide the necessary documentation\nit is increasingly common to use literate programming techniques. Although\nR has had the ability to embed R code in long-form documents describing\nthe analysis and presenting the results via [*Sweave*](https://www.statistik.lmu.de/~leisch/Sweave/), \nit has been the introduction of [*RMarkdown*](http://rmarkdown.rstudio.com/) \nthat has driven the increasing popularity of this approach. The relative\nsimplicity of authoring [*Markdown*](https://daringfireball.net/projects/markdown/) \ndocuments and the ability to convert these into a large variety of output formats\nvia [*pandoc*](http://pandoc.org/) combined with the tight integration with \n[*RStudio*](https://www.rstudio.com/) make this approach easy to use and\npowerful at the same time. \n\nRStudio's support for RMarkdown templates and custom\ndocument formats has enabled the community to provide templates that are\ntailored towards specific use cases and integrate well with RStudio. The\ndocument format provided by *reportMD* was inspired by, and is in part based on, [knitrBootstrap](https://github.com/jimhester/knitrBootstrap).\n\nUnlike currently available tools used to\nfacilitate this literate programming approach to data analysis *reportMD* \nfocuses specifically on complex data analyses that may not be well suited to the\nmonolithic document format typical of RMarkdown. Complex analysis are best split into smaller units\nbut are likely to depend on the results of earlier stages of the analysis.\nThis R package aims to provide a number of features to support analyses\nthat are split across multiple RMarkdown files with cross-file dependencies\nand enables multi-page HTML output.\n\nAn example of a report generated with *reportMD* is available [online](https://humburg.github.io/reportmd/).\n\n## Installation\nTo install *reportMD* and some of the dependancies requires [*devtools*](https://github.com/hadley/devtools).\nUsers of [*RStudio*](https://www.rstudio.com/) will already have this installed,\notherwise `install.packages('devtools')` will take care of that.\n\nThe latest version of *reportMD* can be installed:\n\n```r\ndevtools::install_github('humburg/reportMD')\n```\n\n## Getting started\nThe [Multi-document Rmarkdown template](inst/rmarkdown/templates/multipart_report/skeleton/skeleton.Rmd)\nincluded in this package has detailed instructions and examples. In *RStudio* select \n\n\u003e    File \u003e New File \u003e R Markdown \u003e From Template \u003e Multi-part Report {reportMD}\n\nThis will create a copy of the template in the current project. Open the file\n*skeleton.Rmd* and click on RStudio's *Knit* button to compile the template into\na webpage.\n\nAlternatively the template is available as part of the installed R package\nand can be located via the R command\n`system.file('rmarkdown/templates/multipart_report/skeleton', package=\"reportMD\")`.\n\n## Features\nCurrent and planned features include:\n- [x] Ability to declare required RMarkdown documents in yaml header;\n    - [x] Dependencies are resolved and rendered to the requested output\n      format when the parent document is rendered.\n    - [x] Make declared dependencies available as reference links so that\n      links to these documents can easily inserted into the text using \n      Markdown syntax.\n- [x] Ability to automatically load the results of cached chunks from other\n  other documents;\n- [x] Avoid recompiling child documents whenever possible;\n- [ ] Providing a shorthand to include figures and tables generated by other\n  documents;\n- [ ] Automatic numbering of figures and tables\n    - [x] within each document.\n    - [ ] across linked documents.\n          \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumburg%2Freportmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhumburg%2Freportmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumburg%2Freportmd/lists"}