Release meltr 1.0.0

[jimhester]

First release:

• usethis::use_cran_comments()
• Proof read Title: and Description:
• Check that all exported functions have @returns and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• devtools::build_readme()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• rhub::check_for_cran()
• rhub::check(platform = 'ubuntu-rchk')
• rhub::check_with_sanitizers()
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• usethis::use_github_release()
• usethis::use_news_md()
• usethis::use_dev_version()
• Update install instructions in README
• Finish blog post
• Tweet
• Add link to blog post in pkgdown news menu

[jimhester]

Hi @nacnudus, I think this package is generally ready for a first release.

If you could go through this checklist updating this as needed and verify everything looks good I think we could release it.

If you would like me to review any changes you make before you submit I would be happy to do so.

[nacnudus]

Advice needed

I think these potential problems can be ignored, but I'd appreciate your advice @jimhester.

1. devtools::check(remote = TRUE, manual = TRUE) gives a NOTE: "Compilation used the following non-portable flag(s): ‘-march=x86-64’". I think it can be ignored.
2. rhub::check(platform = 'ubuntu-rchk') fails with PREPERROR (compilation failed for package 'meltr')
3. rhub::check_with_sanitizers() fails with PREPERROR (compilation failed for package 'meltr')
4. devtools::document() gives warnings that seem to be related to Documentation for R6 methods added dynamically by "$set()" roxygen2#931. They are R6 methods, defined dynamically, so that it doesn't seem possible to document them.

Show warnings

> devtools::document()
ℹ Updating meltr documentation
ℹ Loading meltr
Writing NAMESPACE
Warning: [/home/nacnudus/R/meltr/R/callback.R:31] undocumented R6 methods: `initialize`, `receive`, `continue`, `result`, `finally`
Warning: [/home/nacnudus/R/meltr/R/callback.R:36] argument `callback` undocumented for R6 method `initialize()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:37] argument `data` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:37] argument `index` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:48] undocumented R6 methods: `initialize`, `receive`, `continue`
Warning: [/home/nacnudus/R/meltr/R/callback.R:54] argument `callback` undocumented for R6 method `initialize()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:58] argument `data` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:58] argument `index` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:72] undocumented R6 methods: `initialize`, `receive`, `result`, `finally`
Warning: [/home/nacnudus/R/meltr/R/callback.R:78] argument `callback` undocumented for R6 method `initialize()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:81] argument `data` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:81] argument `index` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:98] undocumented R6 methods: `initialize`, `receive`, `result`, `finally`
Warning: [/home/nacnudus/R/meltr/R/callback.R:104] argument `callback` undocumented for R6 method `initialize()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:107] argument `data` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:107] argument `index` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:124] undocumented R6 methods: `initialize`, `receive`, `result`
Warning: [/home/nacnudus/R/meltr/R/callback.R:130] argument `callback` undocumented for R6 method `initialize()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:130] argument `acc` undocumented for R6 method `initialize()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:138] argument `data` undocumented for R6 method `receive()`
Warning: [/home/nacnudus/R/meltr/R/callback.R:138] argument `index` undocumented for R6 method `receive()`
Registered S3 methods overwritten by 'readr':
  method           from 
  print.date_names meltr
  print.locale     meltr
Writing NAMESPACE

extrachecks

These are tasks to be completed to meet https://github.com/DavisVaughan/extrachecks

• Add @returns to exported functions:

  • show_progress()
  • datasource()
  • locale()
  • melt_fwf()
  • melt_delim()
  • melt_delim_chunked()
  • melt_table()
  • tokenizer_delim()
  • date_names()
  • meltr_example()

• Add @examples to exported functions:

  • show_progress()
  • clipboard()
  • Callback classes?

• DESCRIPTION proposed 'Description:' "The goal of 'meltr' is to provide a fast and friendly way to non-rectangular data, such as ragged forms of csv (comma-separated values), tsv (tab-separated values), and fwf (fixed-width format) files." to meet the requirements:

  • "Functions do not need to be put in single quotes, just packages, software names and API names." Presumably file formats do not need to be put in single quotes.
  • "Please always explain all acronyms/abbreviations in the description text in the Description field of the DESCRIPTION"

[jimhester]

1. This flag is likely added by your personal or site makevars, as meltr itself doesn't use a Makevars file. You are right it can be ignored.
   2.,3. I guess we need to figure out why the PREPERROR is happening. Could you link to the logs of the failures? I re-ran the ubuntu-rchk one just now and it worked, it is possible you were running into an issue with a dependency which is now fixed. You may want to try re-running the sanitizer one to be sure.
2. These warnings can be ignored, they are somewhat valid but I don't think it is very important to document these methods for readr or meltr.

[nacnudus]

I've fixed all the items described above.

1. rhub::check_with_sanitizers() still fails with a PREPERROR html build log
2. rhub::check(platform = 'ubuntu-rchk') fails with an ERROR html build log
3. The GitHub action fails on Windows latest (release), but I'm not worried about that.

[jimhester]

The rhub sanitizer error looks like the compiler is not using C++11, if you add SystemRequirements: C++11 to the DESCRIPTION I think they should be fixed.

The rchk results are clean though.

None of the things raised in https://builder.r-hub.io/status/meltr_0.0.0.9000.tar.gz-a3b2bcf546f94757afb8927446e75beb#L2575 are true rchk issues, the tool is just saying it can't analyze the given functions for various reasons.

[jimhester]

I think you can submit this to CRAN whenever you are ready to do so, it looks good to me assuming the system requirements change fixes the sanitizer failures.

[nacnudus]

It is on CRAN.

Should it have a pkgdown site on r-lib.org? If so, is there a process to follow?

[jimhester]

I think it is fine to leave the pkgdown site at https://r-lib.github.io/meltr/ for now.

[jimhester]

Also congrats for the successful CRAN submission 🎉!

[nacnudus]

Thanks, and thanks for doing almost all the work!