typos in set_entrez_key docs

R/api_keys.r

@@ -4,18 +4,21 @@
 
 #' Set the ENTREZ_KEY variable to be used by all rentrez functions
 #'
-#' The NCBI allows users to acess more records (10 per second) if they 
+#' The NCBI allows users to access more records (10 per second) if they 
 #' register for and use an API key. This function allows users to set this key
 #' for all calls to rentrez functions during a particular R session. See the
-#' vignette section "Making use of API keys" for a detailed description.
+#' vignette section "Using API keys" for a detailed description.
 #'@export
-#'@param key characater. Value to set ENTREZ_KEY to.
-#
+#'@param key character. Value to set ENTREZ_KEY to (i.e. your API key).
+#'@return A logical of length one, TRUE is the value was set FALSE if not.
+#' value is returned inside invisible(), i.e. it is not printed to screen 
+#' when the function is called.
+
 set_entrez_key <- function(key){
     Sys.setenv(ENTREZ_KEY=key)        
 }
 
-#internal function, used to test existance of key.
+#internal function, used to test existence of key.
 is_entrez_key_set <- function(){
     !identical(Sys.getenv('ENTREZ_KEY'), "")
 }