Skip to content

Commit

Permalink
minor typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
robchallen committed Oct 4, 2022
1 parent bb97d5d commit 60bb9f6
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 15 deletions.
9 changes: 6 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,16 @@ here::i_am("README.Rmd")
[![R-CMD-check](https://github.com/terminological/dtrackr/workflows/R-CMD-check/badge.svg)](https://github.com/terminological/dtrackr/actions)
[![DOI](https://zenodo.org/badge/335974323.svg)](https://zenodo.org/badge/latestdoi/335974323)
[![dtrackr status badge](https://terminological.r-universe.dev/badges/dtrackr)](https://terminological.r-universe.dev)
[![metacran downloads](https://cranlogs.r-pkg.org/badges/dtrackr)](https://cran.r-project.org/package=dtrackr)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/dtrackr)](https://cran.r-project.org/package=dtrackr)
<!-- [![DOI](https://joss.theoj.org/papers/10.21105/joss.04707/status.svg)](https://doi.org/) -->
<!-- badges: end -->

## Overview

Accurate documentation of a data pipeline is a first step to reproducibility,
and a flow chart describing the steps taken to prepare data is a useful part of
this documentation. In analyses that relies on data that is frequently updated,
this documentation. In analyses that rely on data that is frequently updated,
documenting a data flow by copying and pasting row counts into flowcharts in
PowerPoint becomes quickly tedious. With interactive data analysis, and
particularly using RMarkdown, code execution sometimes happens in a non-linear
Expand All @@ -47,7 +49,7 @@ also a visual check of the actual data processing.

## Installation

In general use `dtrackr` is expected to be installed alongside the `idyverse`
In general use `dtrackr` is expected to be installed alongside the `tidyverse`
set of packages. It is recommended to install `tidyverse` first.

Binary packages of `dtrackr` are available on CRAN and r-universe for `macOS`
Expand Down Expand Up @@ -164,7 +166,8 @@ of `pdf`, `png`, `svg` or `ps`), ready for submission to Nature.
This is a trivial example, but the more complex the pipeline, the bigger
benefit you will get.

Check out the [main documentation for detailed examples](https://terminological.github.io/dtrackr/)
Check out the [main documentation for more details](https://terminological.github.io/dtrackr),
and in particular the [getting started vignette](https://terminological.github.io/dtrackr/articles/dtrackr.html).

## Testing and integration

Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,17 @@
[![DOI](https://zenodo.org/badge/335974323.svg)](https://zenodo.org/badge/latestdoi/335974323)
[![dtrackr status
badge](https://terminological.r-universe.dev/badges/dtrackr)](https://terminological.r-universe.dev)
[![metacran
downloads](https://cranlogs.r-pkg.org/badges/dtrackr)](https://cran.r-project.org/package=dtrackr)
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/dtrackr)](https://cran.r-project.org/package=dtrackr)
<!-- [![DOI](https://joss.theoj.org/papers/10.21105/joss.04707/status.svg)](https://doi.org/) -->
<!-- badges: end -->

## Overview

Accurate documentation of a data pipeline is a first step to
reproducibility, and a flow chart describing the steps taken to prepare
data is a useful part of this documentation. In analyses that relies on
data is a useful part of this documentation. In analyses that rely on
data that is frequently updated, documenting a data flow by copying and
pasting row counts into flowcharts in PowerPoint becomes quickly
tedious. With interactive data analysis, and particularly using
Expand All @@ -35,7 +38,7 @@ visual check of the actual data processing.
## Installation

In general use `dtrackr` is expected to be installed alongside the
`idyverse` set of packages. It is recommended to install `tidyverse`
`tidyverse` set of packages. It is recommended to install `tidyverse`
first.

Binary packages of `dtrackr` are available on CRAN and r-universe for
Expand Down Expand Up @@ -148,8 +151,10 @@ Nature.
This is a trivial example, but the more complex the pipeline, the bigger
benefit you will get.

Check out the [main documentation for detailed
examples](https://terminological.github.io/dtrackr/)
Check out the [main documentation for more
details](https://terminological.github.io/dtrackr), and in particular
the [getting started
vignette](https://terminological.github.io/dtrackr/articles/dtrackr.html).

## Testing and integration

Expand Down
8 changes: 5 additions & 3 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ articles:
dtrackr-options: dtrackr-options.html
dtrackr: dtrackr.html
joining-pipelines: joining-pipelines.html
last_built: 2022-10-04T17:56Z
last_built: 2022-10-04T22:02Z

8 changes: 4 additions & 4 deletions docs/reference/save_dot.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 60bb9f6

Please sign in to comment.