diff --git a/.Rbuildignore b/.Rbuildignore index c6cb2c2..5ad993c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,4 @@ ^pkgdown$ ^\.github$ ^cran-comments\.md$ +^CRAN-SUBMISSION$ diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION new file mode 100644 index 0000000..b2827b6 --- /dev/null +++ b/CRAN-SUBMISSION @@ -0,0 +1,3 @@ +Version: 0.1.0 +Date: 2024-12-27 03:50:21 UTC +SHA: e0c285220dc122c6c2383065aa959c61a7acc503 diff --git a/DESCRIPTION b/DESCRIPTION index 5af29d2..10dab50 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,15 +1,15 @@ Package: biblegatewayr -Title: Access Bible Verses from BibleGateway +Title: Retrieve Bible Verses from Bible Gateway Version: 0.1.0 Authors@R: person("Angel", "Feliz", email = "angel.esteban.feliz@gmail.com", role = c("aut", "cre", "cph"), comment = c(ORCID = "0009-0007-2910-1808")) Description: | - This R package provides functions to interact with the BibleGateway web page. - It includes 'get_bible_verse' to retrieve specific verses by canonical - reference (e.g., "John 3:16") and 'find_bible_verse' to search for verses - containing specific text. Both functions support multiple Bible versions - and return formatted output, making it easy to incorporate Bible verses - into markdown documents. + Provides functions to interact with the BibleGateway web page. It includes + 'get_bible_verse' to retrieve specific verses by canonical reference + (e.g., "John 3:16") and 'find_bible_verse' to search for verses containing + specific text. Both functions support multiple Bible versions and return + formatted output, making it easy to incorporate Bible verses + into 'markdown documents'. License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c5df324 --- /dev/null +++ b/LICENSE @@ -0,0 +1,2 @@ +YEAR: 2024 +COPYRIGHT HOLDER: biblegatewayr authors diff --git a/LICENSE.md b/LICENSE.md index d1cb768..7e289cc 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2024 SearchBible authors +Copyright (c) 2024 biblegatewayr authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/R/find_bible_verse.R b/R/find_bible_verse.R index d327c87..989a6fa 100644 --- a/R/find_bible_verse.R +++ b/R/find_bible_verse.R @@ -11,7 +11,8 @@ #' @return Invisibly returns a character vector with the formatted Bible verse(s) found, #' or NULL if no verses are found. The formatted verses are also printed to the console. #' -#' @examplesIf interactive() +#' @examples +#' if(interactive()){ #' # Search for a single verse (printing to console) #' find_bible_verse("el amor es pasciente") #' @@ -22,7 +23,7 @@ #' #' # Example of no results #' find_bible_verse("this_is_a_non_sense_query") -#' +#' } #' @export find_bible_verse <- function(text_to_find, version = "RVR1960") { # URL Construction and Request diff --git a/R/get_bible_verse.R b/R/get_bible_verse.R index 7fcb99d..308d093 100644 --- a/R/get_bible_verse.R +++ b/R/get_bible_verse.R @@ -11,7 +11,8 @@ #' @return Invisibly returns a character string with the formatted Bible verse, or NULL if no verse is found. #' The formatted verse is also printed to the console. #' -#' @examplesIf interactive() +#' @examples +#' if(interactive()){ #' # Get a specific verse (printing to console) #' get_bible_verse("Juan 3:16") #' @@ -21,6 +22,7 @@ #' #' # Example of no results. #' get_bible_verse("this is a non existing book 1:1") +#' } #' @export get_bible_verse <- function(search, version = "RVR1960") { # URL Construction and Request diff --git a/man/biblegatewayr-package.Rd b/man/biblegatewayr-package.Rd index 4198524..dfd567d 100644 --- a/man/biblegatewayr-package.Rd +++ b/man/biblegatewayr-package.Rd @@ -4,9 +4,9 @@ \name{biblegatewayr-package} \alias{biblegatewayr} \alias{biblegatewayr-package} -\title{biblegatewayr: Access Bible Verses from BibleGateway} +\title{biblegatewayr: Retrieve Bible Verses from Bible Gateway} \description{ -| This R package provides functions to interact with the BibleGateway web page. It includes 'get_bible_verse' to retrieve specific verses by canonical reference (e.g., "John 3:16") and 'find_bible_verse' to search for verses containing specific text. Both functions support multiple Bible versions and return formatted output, making it easy to incorporate Bible verses into markdown documents. +| Provides functions to interact with the BibleGateway web page. It includes 'get_bible_verse' to retrieve specific verses by canonical reference (e.g., "John 3:16") and 'find_bible_verse' to search for verses containing specific text. Both functions support multiple Bible versions and return formatted output, making it easy to incorporate Bible verses into 'markdown documents'. } \seealso{ Useful links: @@ -18,7 +18,7 @@ Useful links: } \author{ -\strong{Maintainer}: Angel Feliz \email{angel.esteban.feliz@gmail.com} (\href{https://orcid.org/0009-0007-2910-1808}{ORCID}) +\strong{Maintainer}: Angel Feliz \email{angel.esteban.feliz@gmail.com} (\href{https://orcid.org/0009-0007-2910-1808}{ORCID}) [copyright holder] } \keyword{internal} diff --git a/man/find_bible_verse.Rd b/man/find_bible_verse.Rd index b5e5ec4..77fd277 100644 --- a/man/find_bible_verse.Rd +++ b/man/find_bible_verse.Rd @@ -22,7 +22,7 @@ This function searches for Bible verses using the BibleGateway web site based on It returns the formatted verse text with context. } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +if(interactive()){ # Search for a single verse (printing to console) find_bible_verse("el amor es pasciente") @@ -33,5 +33,5 @@ cat(result, sep = "\n") # Example of no results find_bible_verse("this_is_a_non_sense_query") -\dontshow{\}) # examplesIf} +} } diff --git a/man/get_bible_verse.Rd b/man/get_bible_verse.Rd index da83929..4ecd76b 100644 --- a/man/get_bible_verse.Rd +++ b/man/get_bible_verse.Rd @@ -22,7 +22,7 @@ This function retrieves a specific Bible verse using the BibleGateway web site based on a verse reference query. It returns the formatted verse text. } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +if(interactive()){ # Get a specific verse (printing to console) get_bible_verse("Juan 3:16") @@ -32,5 +32,5 @@ cat(result) # Example of no results. get_bible_verse("this is a non existing book 1:1") -\dontshow{\}) # examplesIf} +} }