update 6012026

Author: EnriquePH

DESCRIPTION

@@ -13,7 +13,7 @@ Description: Integer sequences from OEIS in R.
 Depends: R (>= 3.3.3)
 License: MIT + file LICENSE
 Encoding: UTF-8
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.0
 Imports:
    xml2,
    rvest,
@@ -28,3 +28,4 @@ Suggests:
     qpdf,
     covr
 VignetteBuilder: knitr
+Roxygen: list(markdown = TRUE)

NAMESPACE

@@ -101,6 +101,7 @@ S3method(OEIS_url,character)
 S3method(OEIS_xml,OEIS_ID)
 S3method(OEIS_xml,character)
 S3method(plot,OEIS_sequence)
+export("%>%")
 export(OEIS_ID)
 export(OEIS_author)
 export(OEIS_bfile)

OEIS.R.Rproj

@@ -20,3 +20,5 @@ PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
 PackageCheckArgs: --as-cran
 PackageRoxygenize: rd,collate,namespace
+
+SpellingDictionary: en_US

R/OEIS_ID.R

@@ -8,31 +8,30 @@
 #  ---------------------------------------------------------------------------
 
 #  OEIS_ID
-#' OEIS sequence authors from \code{internal format}, or from the sequence
-#' \code{ID}.
+#' OEIS sequence authors from `internal format`, or from the sequence
+#' `ID`.
 #'
 #' This function gives the name of the person, or persons, who contributed the
 #' sequence and their emails, if they are present and selected.
 #' @param x can be one of the following:
-#' * A character string with sequence \code{ID}.
-#' * A \code{OEIS_internal} S3 class object, with sequence internal format.
-#' * A S3 classes object \code{OEIS_xml} and \code{xml_document}, with
+#' * A character string with sequence `ID`.
+#' * A `OEIS_internal` S3 class object, with sequence internal format.
+#' * A S3 classes object `OEIS_xml` and `xml_document`, with
 #' sequence content from OEIS web.
-#' * An object of \code{OEIS_sequence} class, that contains all sequence
+#' * An object of `OEIS_sequence` class, that contains all sequence
 #' related data.
-#' * An object of \code{OEIS_bfile} class.
+#' * An object of `OEIS_bfile` class.
 #' @md
 #'
-#' @importFrom magrittr "%>%"
 #' @importFrom magrittr add
 #' @importFrom magrittr add extract2
 #'
-#' @seealso * \code{\link{OEIS_description}}
-#' @seealso * \code{\link{OEIS_internal_format}}
-#' @seealso * \code{\link{OEIS_sequence}}
-#' @seealso * \code{\link{OEIS_check}}
+#' @seealso * [OEIS_description()]
+#' @seealso * [OEIS_internal_format()]
+#' @seealso * [OEIS_sequence()]
+#' @seealso * [OEIS_check()]
 #'
-#' @return A character string with the OEIS sequence \code{ID}.
+#' @return A character string with the OEIS sequence `ID`.
 #'
 #' @examples
 #' id <- "A169890"

R/OEIS_author.R

@@ -8,23 +8,22 @@
 #  ---------------------------------------------------------------------------
 
 #  OEIS_author
-#' OEIS sequence authors from \code{internal format}, or from the sequence
-#' \code{ID}.
+#' OEIS sequence authors from `internal format`, or from the sequence
+#' `ID`.
 #'
 #' This function gives the name of the person, or persons, who contributed the
 #' sequence and their emails, if they are present and selected.
 #' @inheritParams OEIS_description
-#' @param email A logical, by specifying: \code{email = TRUE}, the
+#' @param email A logical, by specifying: `email = TRUE`, the
 #' author's email is returned, if present, with the author's name.
-#' The default value of \code{email} is \code{FALSE}.
+#' The default value of `email` is `FALSE`.
 #'
-#' @importFrom magrittr "%>%"
-#' @importFrom magrittr "%<>%"
+#' @importFrom magrittr %<>%
 #'
-#' @seealso * \code{\link{OEIS_description}}
-#' @seealso * \code{\link{OEIS_internal_format}}
-#' @seealso * \code{\link{OEIS_sequence}}
-#' @seealso * \code{\link{OEIS_check}}
+#' @seealso * [OEIS_description()]
+#' @seealso * [OEIS_internal_format()]
+#' @seealso * [OEIS_sequence()]
+#' @seealso * [OEIS_check()]
 #'
 #' @return A character vector with the OEIS sequence authors and emails.
 #'

R/OEIS_bfile.R

@@ -8,28 +8,27 @@
 #  ---------------------------------------------------------------------------
 
 #  OEIS_bfile
-#' S3 class constructor for \code{bfile} data.
+#' S3 class constructor for `bfile` data.
 #'
-#' A \code{bfile} is a text formatted file that provides many more terms of a
+#' A `bfile` is a text formatted file that provides many more terms of a
 #' sequence than the typical fifty to eighty terms that can be shown in the main
 #' sequence entry.
-#' @param ID A character string or an object of the class \code{OEIS_ID}
+#' @param ID A character string or an object of the class `OEIS_ID`
 #'
 #' @importFrom utils read.table
-#' @importFrom magrittr "%>%"
 #' @md
-#' @return A S3 object of the class \code{OEIS_bfile} with the following structure:
+#' @return A S3 object of the class `OEIS_bfile` with the following structure:
 #' * __bfile_name__: Name of `bfile`.
 #' * __bfile_url__: Url to `bfile` in the OEIS server.
 #' * __min_n__:  Minimum `n` position of the first term for available values of the sequence.
 #' * __max_n__:  Maximum `n` position of the last term for available values of the sequence.
 #' * __comments__: Text comments included into the `bfile`
 #' * __data__: A data frame including all data within the `bfile` with two
 #'  columns: __n__ and other named as the sequence `ID` including sequence values for __a(n)__.
-#' @seealso * \code{\link{OEIS_bfile_url}}
-#' @seealso * \code{\link{OEIS_sequence}}
-#' @seealso * \code{\link{OEIS_check}}
-#' @seealso * \code{\link{OEIS_download_bfile}}
+#' @seealso * [OEIS_bfile_url()]
+#' @seealso * [OEIS_sequence()]
+#' @seealso * [OEIS_check()]
+#' @seealso * [OEIS_download_bfile()]
 #'
 #' @examples
 #' id <- "A000056"

R/OEIS_bfile_url.R

@@ -8,23 +8,22 @@
 #  ---------------------------------------------------------------------------
 
 #  OEIS_bfile_url
-#' Get sequence data url in \code{bfile} format.
+#' Get sequence data url in `bfile` format.
 #'
-#' A \strong{bfile} is a text formatted file that provides many more terms of a
+#' A **bfile** is a text formatted file that provides many more terms of a
 #' sequence than the typical fifty to eighty terms that can be shown in the main
 #' sequence entry.
 #'
 #' @inheritParams OEIS_check
 #' @param URL A logical that selects if the output is the complete url, or just
-#'   the \code{bfile} file name.
+#'   the `bfile` file name.
 #'
-#' @importFrom magrittr "%>%"
 #'
-#' @return A string with the sequence \strong{bfile} url, or the \strong{bfile}
+#' @return A string with the sequence **bfile** url, or the **bfile**
 #'   file name
 #'
-#' @seealso * \code{\link{OEIS_url}}
-#' @seealso * \code{\link{OEIS_check}}
+#' @seealso * [OEIS_url()]
+#' @seealso * [OEIS_check()]
 #' @export
 #'
 #' @examples

R/OEIS_bibtex.R

@@ -36,7 +36,7 @@ author_list <- function(x) {
 
 #' Getting BibTeX citation from OEIS sequence
 #'
-#' @param x An object of class \code{OEIS_sequence}
+#' @param x An object of class `OEIS_sequence`
 #' @importFrom utils person
 #' @importFrom utils bibentry
 #' @md
@@ -56,17 +56,17 @@ author_list <- function(x) {
 #' @note Fields tags are separated by commas. The last tag finishes with a comma
 #' , although is not necessarily. The tag's name is not case-sensitive but
 #' caps are used.
-#' @note For more help on `bibentry` class, see: \code{\link[utils]{bibentry}}
+#' @note For more help on `bibentry` class, see: [utils::bibentry()]
 #'
-#' @seealso * \code{\link[utils]{person}}
-#' @seealso * \code{\link[utils]{toBibtex}}
-#' @seealso * \code{\link{OEIS_author}}
+#' @seealso * [utils::person()]
+#' @seealso * [utils::toBibtex()]
+#' @seealso * [OEIS_author()]
 #' @references
-#' * \href{http://www.bibtex.org/Format/}{BibTeX Format Description}
-#' * \href{http://psychedelic-geometry.blogspot.com.es/2010/02/bibtex-automatic-oeis-citations.html}{BibTeX AUTOMATIC OEIS CITATIONS}
-#' * \href{https://github.com/Psychedelic-Geometry/OEIS-Mathematica/wiki}{Mathematica OEIS Package}
-#' * \href{https://en.wikipedia.org/wiki/BibTeX}{Wikipedia: BibTex}
-#' * \href{https://oeis.org/wiki/Welcome#reference}{Referencing a Particular Sequence}
+#' * [BibTeX Format Description](http://www.bibtex.org/Format/)
+#' * [BibTeX AUTOMATIC OEIS CITATIONS](http://psychedelic-geometry.blogspot.com.es/2010/02/bibtex-automatic-oeis-citations.html)
+#' * [Mathematica OEIS Package](https://github.com/Psychedelic-Geometry/OEIS-Mathematica/wiki)
+#' * [Wikipedia: BibTex](https://en.wikipedia.org/wiki/BibTeX)
+#' * [Referencing a Particular Sequence](https://oeis.org/wiki/Welcome#reference)
 #' @export
 #'
 #' @examples

R/OEIS_check.R

@@ -10,19 +10,20 @@
 #  OEIS_check
 #' OEIS ID Validation
 #'
-#' @param ID A string with the OEIS sequence identifier \code{ID} number.
-#' The A-number or sequence \code{ID} is the absolute catalog number of the
+#' @param ID A string with the OEIS sequence identifier `ID` number.
+#' The A-number or sequence `ID` is the absolute catalog number of the
 #' sequence. It consists of "A" followed by 6 digits.
 #'
-#' @seealso * \code{\link{OEIS_url}}
-#' @seealso * \code{\link{OEIS_ID}}
+#' @seealso * [OEIS_url()]
+#' @seealso * [OEIS_ID()]
 #'
-#' @return An object of class \code{"OEIS_ID"} or an error if \code{ID} is not
+#' @return An object of class `"OEIS_ID"` or an error if `ID` is not
 #'   an OEIS valid ID
 #' @export
 #'
 #' @examples
 #' OEIS_check("A002000")
+#'
 OEIS_check <- function(ID) {
   if (!grepl("^A\\d{6}$", ID)) {
     stop(paste0("\"", ID, "\" is not an OEIS valid ID"))

R/OEIS_comments.R

@@ -8,22 +8,21 @@
 #  ---------------------------------------------------------------------------
 
 #  OEIS_comments
-#' OEIS sequence comments lines from sequence \code{internal_format}
+#' OEIS sequence comments lines from sequence `internal_format`
 #'
 #' The comments field in OEIS sequence entries is for information that does
 #' not quite fit in other fields.
 #' @inheritParams OEIS_description
 #'
-#' @importFrom magrittr "%>%"
 #'
-#' @seealso * \code{\link{OEIS_description}}
-#' @seealso * \code{\link{OEIS_author}}
-#' @seealso * \code{\link{OEIS_internal_format}}
-#' @seealso * \code{\link{OEIS_formula}}
-#' @seealso * \code{\link{OEIS_sequence}}
-#' @seealso * \code{\link{OEIS_xml}}
+#' @seealso * [OEIS_description()]
+#' @seealso * [OEIS_author()]
+#' @seealso * [OEIS_internal_format()]
+#' @seealso * [OEIS_formula()]
+#' @seealso * [OEIS_sequence()]
+#' @seealso * [OEIS_xml()]
 #' @return A character string with the OEIS sequence comments lines from the
-#'    sequence or \code{NULL} if there are no comments.
+#'    sequence or `NULL` if there are no comments.
 #'
 #' @examples
 #' id <- "A105805"