-
Notifications
You must be signed in to change notification settings - Fork 0
/
gedcompendium.Rmd
33 lines (21 loc) · 1.76 KB
/
gedcompendium.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
---
title: "The gedcompendium"
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```
## Introduction
The `tidyged` package is the core package of the `gedcompendium` ecosystem of packages.
```{r, echo=FALSE, out.width="65%", fig.align='center'}
knitr::include_graphics("https://github.com/jl5000/tidyged/raw/master/man/figures/allhex.png")
```
## Packages
The `gedcompendium` is being developed in three phases:
1. The `tidyged` package has a dependency on the `tidyged.internals` package, which contains the codification of the GEDCOM 5.5.5 specification. The user is kept away from the complexity of this infrastructure, and instead interacts with various wrapper functions found in the `tidyged` package. There is also a dependency on the `tidyged.io` package which is used for importing GEDCOM files and exporting `tidyged` objects as GEDCOM files. The `tidyged.utils` package has a number of additional functions to help maintain and clean GEDCOM files.
2. The `tidyged` package is intended to be used interactively at the console or in scripts. However its utility is somewhat limited by the lack of an interactive interface. The longer term plan is for the `shinyged` package to provide a `shiny` interface. This will also enable the `autoged` package to allow an evidence-driven approach to record facts from source documents.
3. There are also packages used to generate visualisations and RMarkdown-based reports of the content of GEDCOM files; `visged` and `geddown`.
Phase 1 is almost complete. Phase 2 will begin in mid-2021. It will probably take until around 2023 for me to finish it all.
<p style="text-align: right;"><a href="https://jl5000.github.io/tidyged/articles/tidyged_creation.html">Next article: Creating tidyged objects ></a></p>