Skip to content

Commit 943610f

Browse files
committed
Update README.md
1 parent d1e76c0 commit 943610f

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,9 @@ It was designed with medical, census, and survey data in mind, where dataframes
1515
# Installation
1616

1717
``` r
18-
# Install it from CRAN
19-
install.packages("siftr")
18+
# CRAN soon
2019

2120
# Or install the live development version from Github.
22-
# Want to know what this version has compared to CRAN? See 'NEWS.md' above.
2321
remotes::install_github("DesiQuintans/siftr")
2422
```
2523

@@ -42,12 +40,15 @@ options(defaultPackages = c('datasets', 'utils', 'grDevices', 'graphics', 'stats
4240

4341
# Functions in `siftr`
4442

45-
| Function | Description |
46-
|:-----------------|:-----------------------------------------------------|
47-
| `sift()` | Search through a dataframe's columns. |
43+
| Function | Description |
44+
|:--------------------|:-------------------------------------------------------|
45+
| `sift()` | Search through a dataframe's columns. |
46+
| `sift.name()` | Only search variable names (i.e. column names). |
47+
| `sift.desc()` | Only search descriptive labels. |
48+
| `sift.factors()` | Only search factor labels (and value labels). |
4849
| `save_dictionary()` | Save the data dictionary for use with [`tsv2label`][1] |
49-
| `options_sift()` | Get and set options related to how `sift` functions. |
50-
| `mtcars_lab` | A dataset bundled with the package for testing. |
50+
| `options_sift()` | Get and set options related to how `siftr` functions. |
51+
| `mtcars_lab` | A dataset bundled with the package for testing. |
5152

5253

5354

0 commit comments

Comments
 (0)