CRAN corrections

.Rbuildignore

@@ -8,3 +8,4 @@
 ^pkgdown$
 ^README\.Rmd$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$

.gitignore

@@ -48,3 +48,6 @@ docs/
 docs
 
 /.quarto/
+
+# CRAN
+CRAN-SUBMISSION

DESCRIPTION

@@ -3,7 +3,11 @@ Title: Read Markdown Tables into Tibbles
 Version: 0.1.1
 Authors@R: 
     person("Jordan", "Bradford", , "[email protected]", role = c("aut", "cre", "cph"))
-Description: Read markdown tables from a string, file, or URL into tibbles.
+Description: Functions for reading raw markdown tables from a 
+    string, file, or URL into tibbles. It includes options to 
+    warn users about potential issues with the markdown table 
+    format, ensuring robust data handling even if the table has
+    minor formatting errors.
 Imports:
     cli,
     httr2,

R/read_md_table.R

@@ -14,12 +14,12 @@
 #'   leading or trailing pipes, warnings will be raised
 #'   but the data will be read correctly.
 #'   [`readr::read_delim`] will provide its own warnings
-#'   if there are potential issue.
+#'   if there are potential issues.
 #'
 #' @param file Either a path to a file, a connection, or
 #'   literal data (either a single string or a raw vector).
-#'   Files starting with `http://`, `https://`,
-#'   `ftp://`, or `ftps://` will be automatically downloaded.
+#'   Files starting with `http://`, `https://`, `ftp://`,
+#'   or `ftps://` will be automatically downloaded.
 #'
 #' @param warn Boolean. Should `read_md_table` warn
 #'   about possible issues with the passed `file`?
@@ -36,7 +36,7 @@
 #' # Read from a string
 #' read_md_table("| H1 | H2 | \n|-----|-----|\n| R1C1 | R1C2 |\n| R2C1 | R2C2 |")
 #'
-#' \dontrun{
+#' \donttest{
 #' # Read from a URL
 #' read_md_table(
 #'   "https://raw.githubusercontent.com/jrdnbradford/readMDTable/main/inst/extdata/iris.md"

R/read_md_table_example.R

@@ -1,7 +1,9 @@
 #' @title Get Path to readMDTable Examples
 #'
-#' @details readMDTable comes bundled with a number of sample files
-#' in `inst/extdata` directory. This function makes them easy to access.
+#' @details readMDTable comes with a number of well-known
+#' datasets as example markdown tables in the `inst/extdata`
+#' directory. `read_md_table_example` will list the file
+#' names or return the path of a specified file.
 #'
 #' @param file Name of file. If `NULL`, the example files will be listed.
 #'
@@ -18,8 +20,6 @@
 #' # Read in an example file
 #' mtcars_path <- read_md_table_example("mtcars.md")
 #' read_md_table(mtcars_path)
-#' @references This function and setup follows [`readr::readr_example`].
-#'
 #' @export
 read_md_table_example <- function(file = NULL) {
   if (is.null(file)) {

README.md

@@ -4,8 +4,6 @@
 <!-- badges: start -->
 
 [![R-CMD-check](https://github.com/jrdnbradford/readMDTable/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jrdnbradford/readMDTable/actions/workflows/R-CMD-check.yaml)
-[![CRAN
-status](https://www.r-pkg.org/badges/version/readMDTable)](https://CRAN.R-project.org/package=readMDTable)
 [![Dev
 status](https://img.shields.io/github/r-package/v/jrdnbradford/readMDTable/main?label=Dev%20Version&logo=github&labelColor=3e474f&logoColor=959da5)](https://github.com/jrdnbradford/readMDTable)
 [![GitHub