Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherDT committed Aug 31, 2023
1 parent 3c47df0 commit 65ef5f5
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To receive data as a dataframe (rather than json), you can use the `as.data.fram
as.data.frame(get_data("<serial-number>"))

# Pipe it through
get_data("<serial-number>") > as.data.frame()
get_data("<serial-number>") %>% as.data.frame()
```


Expand Down Expand Up @@ -152,15 +152,16 @@ get_data("<serial-number>"), sort = 'timestamp,desc')
Tests are run automatically when pull requests are made against the `main` branch via a github action. To run locally:

```R
TODO
devtools::test()
```

To build a new version of the docs pdf:

```R
TODO
devtools::document() # in case any changes were made to the documentation in the code
devtools::build_manual() # to build the pdf
```

To contribute to this library, please submit a pull request with documentation and notes about what changed and why. Please be as descriptive as possible, add tests where necessary, and add an appropriate label. A QuantAQ maintainer will review and merge PRs as they are received.

If you notice any bugs or have questions about this library, please create an Issue using the GitHub Issues feature.
If you notice any bugs or have questions about this library, please create an Issue using the GitHub Issues feature.

0 comments on commit 65ef5f5

Please sign in to comment.