Skip to content

Commit

Permalink
changed language, remove term 'valid'
Browse files Browse the repository at this point in the history
  • Loading branch information
khusmann committed Mar 1, 2024
1 parent 28817fd commit cb84ef0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ library(dplyr)

When a value is missing in your data, sometimes you want to know *why* it is
missing. Many textual tabular data sources will encode missing reasons as
special values *interlaced* with the valid values in a column (e.g. `N/A`,
special values *interlaced* with the regular values in a column (e.g. `N/A`,
`REFUSED`, `-99`, etc.). Unfortunately, the missing reasons are
lost when these values are all converted into a single `NA` type. Working
with missing reasons has traditionally required loading all variables as
Expand Down Expand Up @@ -83,7 +83,7 @@ As you can see, each source variable is loaded into two columns: one for vaild
values, and the other for missing reasons. Missing reason columns are denoted
by column names surrounded by dots (e.g. `.age.` is the missing reason for the
`age` column). When a value is `NA`, it always has a reason in the missing
reason column. Similarly, when a missing reason is `NA`, it always has a valid
reason column. Similarly, when a missing reason is `NA`, it always has a
value in the value column.

This allows us to separately reference values and missing reasons
Expand All @@ -101,7 +101,7 @@ ex |>
```

(Note that the `<NA>` category in the result refers to the mean age of responses
*without* missing color values, i.e. with valid favorite color responses).
*without* missing color values, i.e. with available favorite color responses).

But this just scratches the surface of what can be done with interlacer...
check out `vignette("interlacer")` for a more complete overview!
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

When a value is missing in your data, sometimes you want to know *why*
it is missing. Many textual tabular data sources will encode missing
reasons as special values *interlaced* with the valid values in a column
(e.g. `N/A`, `REFUSED`, `-99`, etc.). Unfortunately, the missing reasons
are lost when these values are all converted into a single `NA` type.
Working with missing reasons has traditionally required loading all
variables as character vectors and doing a bunch of string operations
and type conversions to make sense of them.
reasons as special values *interlaced* with the regular values in a
column (e.g. `N/A`, `REFUSED`, `-99`, etc.). Unfortunately, the missing
reasons are lost when these values are all converted into a single `NA`
type. Working with missing reasons has traditionally required loading
all variables as character vectors and doing a bunch of string
operations and type conversions to make sense of them.

Interlacer was created based on the insight that values and missing
reasons can be handled as separate *channels* of the same variable.
Expand Down Expand Up @@ -88,7 +88,7 @@ vaild values, and the other for missing reasons. Missing reason columns
are denoted by column names surrounded by dots (e.g. `.age.` is the
missing reason for the `age` column). When a value is `NA`, it always
has a reason in the missing reason column. Similarly, when a missing
reason is `NA`, it always has a valid value in the value column.
reason is `NA`, it always has a value in the value column.

This allows us to separately reference values and missing reasons in a
tidy and type-aware manner. For example, if I wanted to get a breakdown
Expand All @@ -112,8 +112,8 @@ ex |>
```

(Note that the `<NA>` category in the result refers to the mean age of
responses *without* missing color values, i.e. with valid favorite color
responses).
responses *without* missing color values, i.e. with available favorite
color responses).

But this just scratches the surface of what can be done with interlacer…
check out `vignette("interlacer")` for a more complete overview!
Expand Down

0 comments on commit cb84ef0

Please sign in to comment.