https://github.com/matt-dray/wordup
:page_with_curl::speaking_head: R package: Word to Govspeak [WIP]
https://github.com/matt-dray/wordup
govspeak uk-gov-data-science word xml
Last synced: 5 months ago
JSON representation
:page_with_curl::speaking_head: R package: Word to Govspeak [WIP]
- Host: GitHub
- URL: https://github.com/matt-dray/wordup
- Owner: matt-dray
- License: other
- Created: 2023-06-14T15:23:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-30T11:02:04.000Z (over 2 years ago)
- Last Synced: 2025-10-12T13:36:17.005Z (9 months ago)
- Topics: govspeak, uk-gov-data-science, word, xml
- Language: R
- Homepage:
- Size: 62.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# {wordup}
[](https://www.repostatus.org/#concept)
[](https://github.com/matt-dray/wordup/actions)
[](https://www.rostrum.blog/2023/06/21/wordup-tables/)
## Purpose
Convert a Microsoft Word document (docx) to [Govspeak Markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown), which is the format required to publish on [GOV.UK](https://www.gov.uk/).
This package is a personal project for learning purposes. It may never be finished and has no guarantees.
## Motivation and scope
Producers of [statistical publications](https://www.gov.uk/search/research-and-statistics?content_store_document_type=statistics_published&order=updated-newest) might draft their reports in docx format. Publishers need to convert these to Govspeak Markdown so they can be uploaded to the Government's publishing platform. This can be time consuming to do manually and there is potential for error. There's a [Govspeak converter tool](https://govspeak-preview.publishing.service.gov.uk/), but there's some missing functionality, such as handling images and tables.
## Installation
The package is available from GitHub. It isn't stable.
```{r eval=FALSE}
install.packages("remotes") # if not yet installed
remotes::install_github("matt-dray/wordup")
```
Here's the list structure of an example `word/document.xml` from an unzipped docx file.
```{r}
library(wordup)
path <- system.file("examples/simple.docx", package = "wordup")
body_list <- wu_read(path)
str(body_list, give.attr = FALSE, max.level = 3)
```
We can delve into this structure to retrieve text, etc.
```{r}
body_list$document$body[[5]]
```
Hopefully {wordup} will get functions to grab text and styles, apply Govspeak styling and then output a Markdown file. It could also convert images to SVG and insert anchor links for them.
## Related
There are existing packages that can convert [R Markdown](https://rmarkdown.rstudio.com/) to Govspeak:
* [{govspeaker}](https://github.com/best-practice-and-impact/govspeakr) (archived)
* [{mojgovspeak}](https://github.com/moj-analytical-services/mojspeakr)
* [{rgovspeak}](https://github.com/Defra-Data-Science-Centre-of-Excellence/rgovspeak)
For handling Word documents in R:
* [{officer}](https://davidgohel.github.io/officer/) can read a Word document to a tidy table
* [{docxtractr}](https://github.com/hrbrmstr/docxtractr) can extract tables, comments and other things