{"id":18555392,"url":"https://github.com/bearloga/wmf-product-analytics-report","last_synced_at":"2025-04-09T23:32:16.781Z","repository":{"id":146996698,"uuid":"146034105","full_name":"bearloga/wmf-product-analytics-report","owner":"bearloga","description":"An R Markdown report template based on {memor} template, for use by Wikimedia Foundation's Product Analytics team","archived":true,"fork":false,"pushed_at":"2020-05-12T16:12:07.000Z","size":554,"stargazers_count":3,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-03T11:43:45.236Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bearloga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-08-24T19:54:53.000Z","updated_at":"2024-08-08T14:04:36.000Z","dependencies_parsed_at":"2023-05-29T09:00:16.064Z","dependency_job_id":null,"html_url":"https://github.com/bearloga/wmf-product-analytics-report","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/bearloga%2Fwmf-product-analytics-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bearloga%2Fwmf-product-analytics-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bearloga%2Fwmf-product-analytics-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bearloga%2Fwmf-product-analytics-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bearloga","download_url":"https://codeload.github.com/bearloga/wmf-product-analytics-report/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248129921,"owners_count":21052663,"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":[],"created_at":"2024-11-06T21:26:25.327Z","updated_at":"2025-04-09T23:32:16.766Z","avatar_url":"https://github.com/bearloga.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WMF Product Analytics Reporting Template\n\nA report template, based on [memor](https://hebrewseniorlife.github.io/memor/) template, for use by the [Product Analytics](https://www.mediawiki.org/wiki/Product_Analytics) team within [Wikimedia Audiences](https://www.mediawiki.org/wiki/Wikimedia_Audiences) department.\n\n**Note**: this report template uses [R Markdown](https://rmarkdown.rstudio.com/), which [supports Python](https://rstudio.github.io/reticulate/articles/r_markdown.html), meaning data analysis does not have to be done in R. In addition to that, [data can fetched with SQL](https://bookdown.org/yihui/rmarkdown/language-engines.html#sql) from a database and then transferred between R and Python chunks. For example, see [python.Rmd](inst/example/python.Rmd) and [python.pdf](inst/example/python.pdf):\n\n![Pages 1 and 2 of an example report which uses Python and R](example_a.png)\n![Pages 3 and 4 of an example report which uses Python and R](example_b.png)\n\n## Prerequisites\n\n- **Fonts**\n  - xelatex engine\n    - most easily installed with [tinytex](https://yihui.name/tinytex/) R package: `tinytex::install_tinytex()`\n  - [Montserrat](https://fonts.google.com/specimen/Montserrat) (Bold) for header text\n  - [Source Serif Pro](https://fonts.google.com/specimen/Source+Serif+Pro) for body text\n- [Pandoc](https://pandoc.org/)\n  - bundled with [RStudio](https://www.rstudio.com/products/rstudio/)\n  - if installing separately (i.e. via Homebrew), install `pandoc-citeproc` too\n\n## Installation\n\n```R\n# install.packages(\"remotes\")\nremotes::install_github(\"bearloga/wmf-product-analytics-report\")\n```\n\nAlthough I recommend using this command instead:\n\n```R\nremotes::install_github(\"bearloga/wmf-product-analytics-report\", dependencies = \"Suggests\")\n```\n\n## Usage\n\nIf using the RStudio IDE (recommended), use **File → New File → R Markdown** and select \"Product Analytics Report\" in the **From Template** panel, or use the following specification in the front-matter YAML of an existing R Markdown document:\n\n```YAML\noutput: wmfpar::pdf_report\nnocite: \"@*\"\n```\n\nThen, either use the Knit feature in the RStudio IDE (recommended) or run the following in R:\n\n```R\nrmarkdown::render(\"input.Rmd\", wmfpar::pdf_report())\n```\n\n### Bibliography\n\nBy default, the template cites the following necessary R packages: `base`, `rmarkdown`, `knitr`, `memor`, and `wmfpar` (itself). The `cite_r_packages` option is used to add packages to the list. For example:\n\n```YAML\noutput:\n  wmfpar::pdf_report:\n    cite_r_packages:\n      - kableExtra\n      - ggplot2\nnocite: \"@*\"\n```\n\nIf you have additional `.bib` files you wish to include, use the `extra_bibs` option. For example, if you had a `dl.bib` file with BibTeX entries for TensorFlow and books \u0026 articles related to deep learning and you used the R interface to TF, you would use the following:\n\n```YAML\noutput:\n  wmfpar::pdf_report:\n    cite_r_packages:\n      - tensorflow\n      - keras\n    extra_bibs:\n      - dl.bib\nnocite: \"@*\"\n```\n\n**Note**: I still need to figure out how to include `nocite` by default without having to specify it in the front-matter YAML. (Issue #1)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbearloga%2Fwmf-product-analytics-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbearloga%2Fwmf-product-analytics-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbearloga%2Fwmf-product-analytics-report/lists"}