Prepare 'mctq' for CRAN submission

ropensci · Oct 30, 2021 · 7de1e9e · 7de1e9e
1 parent 88f1c01
commit 7de1e9e
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 26 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: mctq
 Title: An R Package for the Munich ChronoType Questionnaire
-Version: 0.0.0.9002
+Version: 0.0.0
 Authors@R: 
     c(person(given = "Daniel",
              family = "Vartanian",

diff --git a/NEWS.md b/NEWS.md
@@ -1,16 +1,22 @@
 <!--- https://devguide.ropensci.org/releasing.html -->
 <!--- https://style.tidyverse.org/news.html -->
 
+# mctq 0.0.0 (2021-10-30)
+
+* First stable `mctq` release. 🎉
+* Now on CRAN! You can install `mctq` with `install.packages("mctq")`.
+
+
 # mctq 0.0.0.9002
 
 ## Changed
 
 * `mctq` is now a
 [peer-reviewed](https://github.com/ropensci/software-review/issues/434) package
 by @ropensci! 🎉
-* The package repository was transfer to the @ropensci organization. All links
-related to `mctq` was changed. Old links have an redirect protocol to point to
-new repository and new website.
+* The package repository was transferred to the @ropensci organization. All
+links related to `mctq` have been changed. Old links have a redirect protocol to
+point to the new repository and new website.
 
 
 # mctq 0.0.0.9001

diff --git a/R/qplot_walk.R b/R/qplot_walk.R
@@ -102,6 +102,8 @@
 #'
 #' @examples
 #' \dontrun{
+#' if (interactive()) {
+#'
 #' ## Ploting a single column from `data`
 #'
 #' qplot_walk(mctq::std_mctq$bt_w)
@@ -123,6 +125,7 @@
 #' if (requireNamespace("datasets", quietly = TRUE)) {
 #'     qplot_walk(datasets::iris)
 #'     qplot_walk(datasets::mtcars)
+#' }
 #' }}
 qplot_walk <- function(data, ..., cols = NULL, pattern = NULL,
                        ignore = "character", remove_id = TRUE,

diff --git a/README.Rmd b/README.Rmd
@@ -23,9 +23,9 @@ library(hms)
 [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/434_status.svg)](https://github.com/ropensci/software-review/issues/434)
 [![CRAN status](https://www.r-pkg.org/badges/version/mctq)](https://CRAN.R-project.org/package=mctq)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
+[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
 [![R-CMD-check](https://github.com/ropensci/mctq/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/mctq/actions)
-[![Codecov test coverage](https://codecov.io/gh/ropensci/mctq/branch/main/graph/badge.svg)](https://codecov.io/gh/ropensci/mctq?branch=main)
+[![Codecov test coverage](https://codecov.io/gh/ropensci/mctq/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropensci/mctq?branch=main)
 [![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://choosealicense.com/licenses/mit/)
 [![Buy Me A Coffee donate button](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://ko-fi.com/danielvartan)
 <!-- badges: end -->

diff --git a/README.md b/README.md
@@ -13,10 +13,10 @@ status](https://www.r-pkg.org/badges/version/mctq)](https://CRAN.R-project.org/p
 state and is being actively
 developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![Lifecycle:
-maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
+maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
 [![R-CMD-check](https://github.com/ropensci/mctq/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/mctq/actions)
 [![Codecov test
-coverage](https://codecov.io/gh/ropensci/mctq/branch/main/graph/badge.svg)](https://codecov.io/gh/ropensci/mctq?branch=main)
+coverage](https://codecov.io/gh/ropensci/mctq/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropensci/mctq?branch=main)
 [![License:
 MIT](https://img.shields.io/badge/license-MIT-green)](https://choosealicense.com/licenses/mit/)
 [![Buy Me A Coffee donate

diff --git a/codemeta.json b/codemeta.json
@@ -1,8 +1,5 @@
 {
-  "@context": [
-    "https://doi.org/10.5063/schema/codemeta-2.0",
-    "http://schema.org"
-  ],
+  "@context": ["https://doi.org/10.5063/schema/codemeta-2.0", "http://schema.org"],
   "@type": "SoftwareSourceCode",
   "identifier": "mctq",
   "description": "A complete and consistent toolkit to process the Munich\n    ChronoType Questionnaire (MCTQ) for its three versions (standard,\n    micro, and shift).",
@@ -11,7 +8,7 @@
   "relatedLink": "https://docs.ropensci.org/mctq/",
   "issueTracker": "https://github.com/ropensci/mctq/issues/",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.0.0.9002",
+  "version": "0.0.0",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -289,21 +286,15 @@
   ],
   "releaseNotes": "https://github.com/ropensci/mctq/blob/master/NEWS.md",
   "readme": "https://github.com/ropensci/mctq/blob/main/README.md",
-  "fileSize": "672.358KB",
+  "fileSize": "672.137KB",
   "contIntegration": ["https://github.com/ropensci/mctq/actions", "https://codecov.io/gh/ropensci/mctq?branch=main"],
   "developmentStatus": ["https://www.repostatus.org/#active", "https://www.tidyverse.org/lifecycle/#maturing"],
   "review": {
     "@type": "Review",
     "url": "https://github.com/ropensci/software-review/issues/434",
     "provider": "https://ropensci.org"
   },
-  "keywords": [
-    "chronobiology",
-    "mctq",
-    "sleep",
-    "r-package",
-    "peer-reviewed"
-  ],
+  "keywords": ["chronobiology", "mctq", "sleep", "r-package", "peer-reviewed"],
   "citation": [
     {
       "@type": "CreativeWork",

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,7 +1,25 @@
 New submission.
 
+## Test environments
+
+* R-hub windows-x86_64-devel (r-devel)
+* R-hub ubuntu-gcc-release (r-release)
+* R-hub fedora-clang-devel (r-devel)
+
 ## R CMD check results
 
-0 errors v | 0 warnings v | 0 notes v
+> On windows-x86_64-devel (r-devel), ubuntu-gcc-release (r-release), fedora-clang-devel (r-devel)
+  checking CRAN incoming feasibility ... NOTE
+  Maintainer: 'Daniel Vartanian <danvartan@gmail.com>'
+
+  New submission
+
+  Possibly misspelled words in DESCRIPTION:
+    ChronoType (2:36, 36:5)
+    MCTQ (36:31)
+
+0 errors √ | 0 warnings √ | 1 note x
+
+## Notes
 
-R CMD check succeeded
+* 'ChronoType' and 'MCTQ' are not misspelled words.
diff --git a/man/qplot_walk.Rd b/man/qplot_walk.Rd
diff --git a/tests/testthat.R b/tests/testthat.R
@@ -21,6 +21,7 @@ test_check("mctq")
 # pkgdown::build_favicons(overwrite = TRUE)
 # pkgdown::build_reference(override = list(template = template))
 # pkgdown::build_site(devel = FALSE, override = list(template = template))
+# rhub::check_for_cran()
 # spelling::spell_check_package()
 # spelling::update_wordlist()
 # urlchecker::url_check()

diff --git a/vignettes/mctq.Rmd b/vignettes/mctq.Rmd
@@ -22,7 +22,7 @@ This article takes a quick tour of the Munich Chronotype Questionnaire (MCTQ) ma
 
 The same features presented here can also be used with $\mu$MCTQ. To make it easy for newcomers, some MCTQ$^{Shift}$ functions are not shown.
 
-We assume that you already have [R](https://www.r-project.org/) installed and have some familiarity with R and MCTQ data. We also strongly recommend using [RStudio](https://rstudio.com/) as your IDE (Integrated Development Environment).
+We assume that you already have [R](https://www.r-project.org/) installed and have some familiarity with R and MCTQ data. We also strongly recommend using [RStudio](https://www.rstudio.com/) as your IDE (Integrated Development Environment).
 
 It's a good idea to have the standard MCTQ questionnaire open while reading this introduction. That way you can have a better understanding of the data objects we are going to deal with. You can download a copy of the MCTQ full standard version  [here](https://www.thewep.org/documentations/mctq/item/english-mctq-full).
 
@@ -73,7 +73,7 @@ Teaching you how to parse/convert your data is outside the scope of this article
 
 Here we are interested in two types of time objects: `Duration` objects, to store time spans, such as sleep latency, and `hms` objects, to store local time values, such as bedtime.
 
-But first, let's take a look at the data, shall we? If you're using [RStudio](https://rstudio.com/), you can run the code above and then type `View(data)` in the console to explore it.
+But first, let's take a look at the data, shall we? If you're using [RStudio](https://www.rstudio.com/), you can run the code above and then type `View(data)` in the console to explore it.
 
 ```{r}
 data
@@ -324,7 +324,7 @@ And our final dataset is ...
 data
 ```
 
-If you're using [RStudio](https://rstudio.com/), you can run all the code showed above and then type `View(data)` in the console to explore the final result.
+If you're using [RStudio](https://www.rstudio.com/), you can run all the code showed above and then type `View(data)` in the console to explore the final result.
 
 If you don't feel comfortable with the way `Duration` objects are printed, `mctq` provides a utility function to help you. Just use `pretty_mctq()` to get a better view.