From 65ef5f56d852ab7236bc378c1f8149a82808aeba Mon Sep 17 00:00:00 2001 From: Christopher Date: Thu, 31 Aug 2023 13:55:28 -0700 Subject: [PATCH] readme updates --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9c05b32..f3dbd58 100644 --- a/README.md +++ b/README.md @@ -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("")) # Pipe it through -get_data("") > as.data.frame() +get_data("") %>% as.data.frame() ``` @@ -152,15 +152,16 @@ get_data(""), 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. \ No newline at end of file +If you notice any bugs or have questions about this library, please create an Issue using the GitHub Issues feature.