change uniprot location function names to comply with naming schema

moosa-r · Dec 31, 2024 · de65de3 · de65de3
1 parent c513bcf
commit de65de3
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 33 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -84,15 +84,15 @@ export(rba_uniprot_antigens)
 export(rba_uniprot_antigens_search)
 export(rba_uniprot_coordinates)
 export(rba_uniprot_coordinates_location)
+export(rba_uniprot_coordinates_location_genome)
+export(rba_uniprot_coordinates_location_protein)
 export(rba_uniprot_coordinates_search)
-export(rba_uniprot_coordinates_sequence)
 export(rba_uniprot_epitope)
 export(rba_uniprot_epitope_search)
 export(rba_uniprot_features)
 export(rba_uniprot_features_search)
 export(rba_uniprot_genecentric)
 export(rba_uniprot_genecentric_search)
-export(rba_uniprot_genome_coordinates_sequence)
 export(rba_uniprot_mutagenesis)
 export(rba_uniprot_mutagenesis_search)
 export(rba_uniprot_proteins)

diff --git a/R/uniprot_coordinates.R b/R/uniprot_coordinates.R
@@ -185,20 +185,20 @@ rba_uniprot_coordinates_search <- function(accession = NULL,
 #'
 #' @examples
 #' \donttest{
-#' rba_uniprot_coordinates_sequence(accession = "P25942", p_position = 1)
+#' rba_uniprot_coordinates_location_protein(accession = "P25942", p_position = 1)
 #' }
 #' \donttest{
-#' rba_uniprot_coordinates_sequence(accession = "P25942",
+#' rba_uniprot_coordinates_location_protein(accession = "P25942",
 #'     p_start = 1, p_end = 277)
 #' }
 #'
 #' @family "UniProt - Coordinates"
 #' @export
-rba_uniprot_coordinates_sequence <- function(accession,
-                                             p_position = NULL,
-                                             p_start = NULL,
-                                             p_end = NULL,
-                                             ...) {
+rba_uniprot_coordinates_location_protein <- function(accession,
+                                                     p_position = NULL,
+                                                     p_start = NULL,
+                                                     p_end = NULL,
+                                                     ...) {
   ## Load Global Options
   .rba_ext_args(...)
   ## Check User-input Arguments
@@ -489,13 +489,13 @@ rba_uniprot_coordinates_location <- function(taxid,
 #'
 #' @examples
 #' \donttest{
-#'  rba_uniprot_genome_coordinates_sequence(
+#'  rba_uniprot_coordinates_location_genome(
 #'  taxid = 9606, chromosome = 11, g_position = 36573305)
 #' }
 #'
 #' @family "UniProt - Coordinates"
 #' @export
-rba_uniprot_genome_coordinates_sequence <- function(taxid,
+rba_uniprot_coordinates_location_genome <- function(taxid,
                                                     chromosome,
                                                     g_position = NULL,
                                                     g_start = NULL,

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -201,5 +201,5 @@ reference:
     - starts_with("rba_uniprot_coordinates")
 - subtitle: "Uniparc"
   contents:
-    - starts_with("rba_uniprot_coordinates")
+    - starts_with("rba_uniprot")
 
diff --git a/man/rba_uniprot_coordinates.Rd b/man/rba_uniprot_coordinates.Rd
diff --git a/man/rba_uniprot_coordinates_location.Rd b/man/rba_uniprot_coordinates_location.Rd
diff --git a/...ba_uniprot_genome_coordinates_sequence.Rd → ...ba_uniprot_coordinates_location_genome.Rd b/...ba_uniprot_genome_coordinates_sequence.Rd → ...ba_uniprot_coordinates_location_genome.Rd
diff --git a/man/rba_uniprot_coordinates_sequence.Rd → ...a_uniprot_coordinates_location_protein.Rd b/man/rba_uniprot_coordinates_sequence.Rd → ...a_uniprot_coordinates_location_protein.Rd
diff --git a/man/rba_uniprot_coordinates_search.Rd b/man/rba_uniprot_coordinates_search.Rd