Skip to content

Commit

Permalink
add vignette index to front page
Browse files Browse the repository at this point in the history
  • Loading branch information
khusmann committed Mar 6, 2024
1 parent 91a173f commit 3957e8c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,22 @@ as described in `vignette("interlacer")`. (tldr: It allows us to interact with
a variable as a [`Result` type](https://en.wikipedia.org/wiki/Result_type),
an abstraction often found in functional programming)

Although this may seem like a simple premise on the surface, it has deep
implications! In addition to `vignette("interlacer")`, be sure to also
check out:

- `vignette("mutations")` for a discussion on how to motify data frames when in
this format

- `vignette("column-types")` to see how to handle column-level missing reasons

- `vignette("coded-data")` for some recipies for working with coded data (e.g.
data produced by SPSS, SAS or Stata)

- `vignette("other-approaches")` for a deep dive into how interlacer's approach
compares to other approaches for representing and manipulating missing reasons
alongside data values

This library is currently in its experimental stages, so be aware that its
interface is likely to change in the future. In the meantime, please try it out
and
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ interact with a variable as a [`Result`
type](https://en.wikipedia.org/wiki/Result_type), an abstraction often
found in functional programming)

Although this may seem like a simple premise on the surface, it has deep
implications! In addition to `vignette("interlacer")`, be sure to also
check out:

- `vignette("mutations")` for a discussion on how to motify data frames
when in this format

- `vignette("column-types")` to see how to handle column-level missing
reasons

- `vignette("coded-data")` for some recipies for working with coded data
(e.g. data produced by SPSS, SAS or Stata)

- `vignette("other-approaches")` for a deep dive into how interlacer’s
approach compares to other approaches for representing and
manipulating missing reasons alongside data values

This library is currently in its experimental stages, so be aware that
its interface is likely to change in the future. In the meantime, please
try it out and [let me know what you think](mailto:[email protected])!
Expand Down

0 comments on commit 3957e8c

Please sign in to comment.