Skip to content

Commit

Permalink
sumitted to CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
AngelFelizR committed Dec 27, 2024
1 parent e0c2852 commit 4006343
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 18 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
^pkgdown$
^\.github$
^cran-comments\.md$
^CRAN-SUBMISSION$
3 changes: 3 additions & 0 deletions CRAN-SUBMISSION
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Version: 0.1.0
Date: 2024-12-27 03:50:21 UTC
SHA: e0c285220dc122c6c2383065aa959c61a7acc503
14 changes: 7 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 2 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
YEAR: 2024
COPYRIGHT HOLDER: biblegatewayr authors
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions R/find_bible_verse.R
Original file line number Diff line number Diff line change
Expand Up @@ -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")
#'
Expand All @@ -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
Expand Down
4 changes: 3 additions & 1 deletion R/get_bible_verse.R
Original file line number Diff line number Diff line change
Expand Up @@ -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")
#'
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions man/biblegatewayr-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/find_bible_verse.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/get_bible_verse.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4006343

Please sign in to comment.