Vignette typo patch #5402

davidbudzynski · 2022-06-05T11:43:15Z

I noticed several mistakes in vignettes when learning about data.table, so I thought it'd be a good idea to clean them up. This was done mainly using languagetool in Emacs.

vignettes/datatable-benchmarking.Rmd

vignettes/datatable-importing.Rmd

vignettes/datatable-intro.Rmd

vignettes/datatable-keys-fast-subset.Rmd

davidbudzynski · 2022-06-05T19:22:01Z

Hi @MichaelChirico, thanks for your review! I implemented your review comments, though I think it would be useful if I went through these vignettes with a fine-tooth comb to spot any errors which were missed out by the LanguageTool and add clean them up overall. For example, I noticed that some paragraphs in some vignettes break into a new line at the 80th column, whereas others don't. What do you think about this?

vignettes/datatable-benchmarking.Rmd

vignettes/datatable-importing.Rmd

vignettes/datatable-keys-fast-subset.Rmd

Co-authored-by: Michael Chirico <[email protected]>

davidbudzynski · 2023-11-03T08:18:00Z

No problem at all! I have been following the new developments closely. Fingers crossed it will pick up the steam in 2024! all my commits now should address bits from your review, thanks for your time spent on this.

vignettes/datatable-benchmarking.Rmd

vignettes/datatable-importing.Rmd

vignettes/datatable-keys-fast-subset.Rmd

MichaelChirico · 2024-01-06T14:30:30Z

Thanks for the fixes, and thanks for your patience!

tdhock · 2024-01-08T19:04:21Z

@Anirban166 please read this diff, it would be great if you could read and catch typos like this in all the vignettes.

…5342) * improve documentation for GForce where sorting affects the result * link issue * tests * typo * mention Sys.setlocale * obsolete comment * 1.15.0 on CRAN. Bump to 1.15.99 * Fix transform slowness (#5493) * Fix 5492 by limiting the costly deparse to `nlines=1` * Implementing PR feedbacks * Added inside * Fix typo in name * Idiomatic use of inside * Separating the deparse line limit to a different PR --------- Co-authored-by: Michael Chirico <[email protected]> * Improvements to the introductory vignette (#5836) * Added my improvements to the intro vignette * Removed two lines I added extra as a mistake earlier * Requested changes * Vignette typo patch (#5402) * fix typos and grammatical mistakes * fix typos and punctuation * remove double spaces where it wasn't necessary * fix typos and adhere to British English spelling * fix typos * fix typos * add missing closing bracket * fix typos * review fixes * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Apply suggestions from code review benchmarking Co-authored-by: Michael Chirico <[email protected]> * remove unnecessary [ ] from datatable-keys-fast-subset.Rmd * Update vignettes/datatable-programming.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-reshape.Rmd Co-authored-by: Michael Chirico <[email protected]> * One last batch of fine-tuning --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> * fix bad merge * Improved handling of list columns with NULL entries (#4250) * Updated documentation for rbindlist(fill=TRUE) * Print NULL entries of list as NULL * Added news item * edit NEWS, use '[NULL]' not 'NULL' * fix test * split NEWS item * add example --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * clarify that list input->unnamed list output (#5383) * clarify that list input->unnamed list output * Add example where make.names is used * mention role of make.names * revert from next release branch * manual merge NEWS * manual rebase tests * manual rebase data.table.R * clarify 0 turns off everything --------- Co-authored-by: Ofek <[email protected]> Co-authored-by: Ani <[email protected]> Co-authored-by: David Budzynski <[email protected]> Co-authored-by: Scott Ritchie <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]>

* fix typos and grammatical mistakes * fix typos and punctuation * remove double spaces where it wasn't necessary * fix typos and adhere to British English spelling * fix typos * fix typos * add missing closing bracket * fix typos * review fixes * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Apply suggestions from code review benchmarking Co-authored-by: Michael Chirico <[email protected]> * remove unnecessary [ ] from datatable-keys-fast-subset.Rmd * Update vignettes/datatable-programming.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-reshape.Rmd Co-authored-by: Michael Chirico <[email protected]> * One last batch of fine-tuning --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]>

* 1.15.0 on CRAN. Bump to 1.15.99 * Fix transform slowness (#5493) * Fix 5492 by limiting the costly deparse to `nlines=1` * Implementing PR feedbacks * Added inside * Fix typo in name * Idiomatic use of inside * Separating the deparse line limit to a different PR --------- Co-authored-by: Michael Chirico <[email protected]> * Improvements to the introductory vignette (#5836) * Added my improvements to the intro vignette * Removed two lines I added extra as a mistake earlier * Requested changes * Vignette typo patch (#5402) * fix typos and grammatical mistakes * fix typos and punctuation * remove double spaces where it wasn't necessary * fix typos and adhere to British English spelling * fix typos * fix typos * add missing closing bracket * fix typos * review fixes * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Apply suggestions from code review benchmarking Co-authored-by: Michael Chirico <[email protected]> * remove unnecessary [ ] from datatable-keys-fast-subset.Rmd * Update vignettes/datatable-programming.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-reshape.Rmd Co-authored-by: Michael Chirico <[email protected]> * One last batch of fine-tuning --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> * Improved handling of list columns with NULL entries (#4250) * Updated documentation for rbindlist(fill=TRUE) * Print NULL entries of list as NULL * Added news item * edit NEWS, use '[NULL]' not 'NULL' * fix test * split NEWS item * add example --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * clarify that list input->unnamed list output (#5383) * clarify that list input->unnamed list output * Add example where make.names is used * mention role of make.names * fix subsetting issue in split.data.table (#5368) * fix subsetting issue in split.data.table * add a test * drop=FALSE on inner [ * switch to 3.2.0 R dep (#5905) * Allow early exit from check for eval/evalq in cedta (#5660) * Allow early exit from check for eval/evalq in cedta Done in the browser+untested, please take a second look :) * Use %chin% * nocov new code * frollmax1: frollmax, frollmax adaptive, left adaptive support (#5889) * frollmax exact, buggy fast, no fast adaptive * frollmax fast fixing bugs * frollmax man to fix CRAN check * frollmax fast adaptive non NA, dev * froll docs, adaptive left * no frollmax fast adaptive * frollmax adaptive exact NAs handling * PR summary in news * copy-edit changes from reviews Co-authored-by: Benjamin Schwendinger <[email protected]> * Apply suggestions from code review Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * comment requested by Michael * update NEWS file * Apply suggestions from code review Co-authored-by: Michael Chirico <[email protected]> * Apply suggestions from code review Co-authored-by: Michael Chirico <[email protected]> * add comment requested by Michael * add comment about int iterator for loop over k-1 obs * extra comments * Revert "extra comments" This reverts commit 03af0e3. * add comments to frollmax and frollsum * typo fix --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * Friendlier error in assignment with trailing comma (#5467) * friendlier error in assignment with trailing comma e.g. `DT[, `:=`(a = 1, b = 2,)`. WIP. Need to add tests and such, but editing from browser before I forget. * Another pass * include unnamed indices on RHS too * tests * NEWS * test numbering * explicit example in NEWS * Link to ?read.delim in ?fread to give a closer analogue of expected behavior (#5635) * fread is similar to read.delim (#5634) * Use ?read.csv / ?read.delim --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> * Run GHA jobs on 1-15-99 dev branch (#5909) * Make declarations static for covr (#5910) * class= argument for condition calls * Unify logic with helper * Add tests * Use call.=FALSE where possible * correct caught class * strip call=/call.= handling * botched merge --------- Co-authored-by: Ofek <[email protected]> Co-authored-by: Ani <[email protected]> Co-authored-by: David Budzynski <[email protected]> Co-authored-by: Scott Ritchie <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> Co-authored-by: Jan Gorecki <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> Co-authored-by: Manuel López-Ibáñez <[email protected]>

* 1.15.0 on CRAN. Bump to 1.15.99 * Fix transform slowness (#5493) * Fix 5492 by limiting the costly deparse to `nlines=1` * Implementing PR feedbacks * Added inside * Fix typo in name * Idiomatic use of inside * Separating the deparse line limit to a different PR --------- Co-authored-by: Michael Chirico <[email protected]> * Improvements to the introductory vignette (#5836) * Added my improvements to the intro vignette * Removed two lines I added extra as a mistake earlier * Requested changes * Vignette typo patch (#5402) * fix typos and grammatical mistakes * fix typos and punctuation * remove double spaces where it wasn't necessary * fix typos and adhere to British English spelling * fix typos * fix typos * add missing closing bracket * fix typos * review fixes * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-benchmarking.Rmd Co-authored-by: Michael Chirico <[email protected]> * Apply suggestions from code review benchmarking Co-authored-by: Michael Chirico <[email protected]> * remove unnecessary [ ] from datatable-keys-fast-subset.Rmd * Update vignettes/datatable-programming.Rmd Co-authored-by: Michael Chirico <[email protected]> * Update vignettes/datatable-reshape.Rmd Co-authored-by: Michael Chirico <[email protected]> * One last batch of fine-tuning --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> * Improved handling of list columns with NULL entries (#4250) * Updated documentation for rbindlist(fill=TRUE) * Print NULL entries of list as NULL * Added news item * edit NEWS, use '[NULL]' not 'NULL' * fix test * split NEWS item * add example --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * clarify that list input->unnamed list output (#5383) * clarify that list input->unnamed list output * Add example where make.names is used * mention role of make.names * fix subsetting issue in split.data.table (#5368) * fix subsetting issue in split.data.table * add a test * drop=FALSE on inner [ * switch to 3.2.0 R dep (#5905) * Allow early exit from check for eval/evalq in cedta (#5660) * Allow early exit from check for eval/evalq in cedta Done in the browser+untested, please take a second look :) * Use %chin% * nocov new code * frollmax1: frollmax, frollmax adaptive, left adaptive support (#5889) * frollmax exact, buggy fast, no fast adaptive * frollmax fast fixing bugs * frollmax man to fix CRAN check * frollmax fast adaptive non NA, dev * froll docs, adaptive left * no frollmax fast adaptive * frollmax adaptive exact NAs handling * PR summary in news * copy-edit changes from reviews Co-authored-by: Benjamin Schwendinger <[email protected]> * Apply suggestions from code review Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * comment requested by Michael * update NEWS file * Apply suggestions from code review Co-authored-by: Michael Chirico <[email protected]> * Apply suggestions from code review Co-authored-by: Michael Chirico <[email protected]> * add comment requested by Michael * add comment about int iterator for loop over k-1 obs * extra comments * Revert "extra comments" This reverts commit 03af0e3. * add comments to frollmax and frollsum * typo fix --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> * Friendlier error in assignment with trailing comma (#5467) * friendlier error in assignment with trailing comma e.g. `DT[, `:=`(a = 1, b = 2,)`. WIP. Need to add tests and such, but editing from browser before I forget. * Another pass * include unnamed indices on RHS too * tests * NEWS * test numbering * explicit example in NEWS * Link to ?read.delim in ?fread to give a closer analogue of expected behavior (#5635) * fread is similar to read.delim (#5634) * Use ?read.csv / ?read.delim --------- Co-authored-by: Michael Chirico <[email protected]> Co-authored-by: Michael Chirico <[email protected]> * Run GHA jobs on 1-15-99 dev branch (#5909) * overhauled linter * revert code changes * Initial commit of {lintr} approach * first pass at personalization * first custom linter * delint vignettes * delint tests * delint R sources * rm empty * re-merge * Move config to .ci directory * Use endsWithAny * Make declarations static for covr (#5910) * restore lint on branch * extension needed after all? * set option in R * debug printing * Exact file name in option * really hacky approach * skip more linters * One more round of deactivation * FIx whitespace issues (again??) * botched merge * obsolete branch ref * restore simple CI script thanks to upstream fix * more delint * just disable unused_import_linter() everywhere for now * rm whitespace from atime tests * comment about comment --------- Co-authored-by: Ofek <[email protected]> Co-authored-by: Ani <[email protected]> Co-authored-by: David Budzynski <[email protected]> Co-authored-by: Scott Ritchie <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> Co-authored-by: Jan Gorecki <[email protected]> Co-authored-by: Benjamin Schwendinger <[email protected]> Co-authored-by: Manuel López-Ibáñez <[email protected]>

davidbudzynski added 8 commits June 5, 2022 12:03

fix typos and grammatical mistakes

e47d56f

fix typos and punctuation

177385b

remove double spaces where it wasn't necessary

bcbdf93

fix typos and adhere to British English spelling

b0036bc

fix typos

8ea8850

fix typos

8d92bfe

add missing closing bracket

dcd1093

fix typos

4975bfe

MichaelChirico reviewed Jun 5, 2022

View reviewed changes

vignettes/datatable-benchmarking.Rmd Outdated Show resolved Hide resolved