R/isFunctions.R

In drodriguezperez/whereiam: whereiam: Geolocation package and spherical trigonometry calculations

##
##  List of is.operating_system functions
##
##  Created by Daniel Rodríguez Pérez on 10/4/2013.
##
##  Copyright (c) 2013 Daniel Rodríguez Pérez.
##
##  This program is free software: you can redistribute it and/or modify
##  it under the terms of the GNU General Public License as published by
##  the Free Software Foundation, either version 3 of the License, or
##  (at your option) any later version.
##
##  This program is distributed in the hope that it will be useful,
##  but WITHOUT ANY WARRANTY; without even the implied warranty of
##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
##  GNU General Public License for more details.
##
##  You should have received a copy of the GNU General Public License
##  along with this program.  If not, see <http://www.gnu.org/licenses/>
##

#' Check is the computer is runing OS X
#' 
#' Returns TRUE for computers runing OS X (Macintosh)
#' 
#' @usage is.mac()
#' 
#' @examples
#' if (is.mac()) {
#'   message('The computer is running OS X')
#' }
#' 
#' @export is.mac
#' @aliases is.mac is.mac
is.mac <- function() {
  if (tolower(Sys.info()['sysname']) == 'darwin')
    return(TRUE)
  else
    return(FALSE)
}

#' Check is the computer is runing Windows
#' 
#' Returns TRUE for computers runing Windows OS
#' 
#' @usage is.windows()
#' 
#' @examples
#' if (is.windows()) {
#'   message('The computer is running Windows OS')
#' }
#' 
#' @export is.windows
#' @aliases is.windows is.windows
is.windows <- function() {
  if (tolower(Sys.info()['sysname']) == 'windows')
    return(TRUE)
  else
    return(FALSE)
}

#' Check is the computer is runing Linux
#' 
#' Returns TRUE for computers runing Linux OS
#' 
#' @usage is.linux()
#' 
#' @examples
#' if (is.linux()) {
#'   message('The computer is running GNU/Linux OS')
#' }
#'  
#' @export is.linux
#' @aliases is.linux is.linux
is.linux <- function() {
  if (tolower(Sys.info()['sysname']) == 'linux')
    return(TRUE)
  else
    return(FALSE)
}

#' Validate a latitude value
#' 
#' Return a TRUE value is the input parameter is a valid latitude value, FALSE
#' otherwise
#' 
#' @param latitude a latitude coordinate value
#' 
#' @examples
#' # return a true value
#' is.latitude(40)
#' 
#' # return a false value
#' is.latitude(100)
#' 
#' @rdname is.latitude
#' @export is.latitude
#' @aliases is.latitude
is.latitude <- function(latitude) {
  if (is.numeric(latitude)) {
    if(latitude >= -90 && latitude <= 90) {
      return(TRUE)
    } else {
      return(FALSE)
    }
  } else {
    return(FALSE)
  }
}

#' Validate a longitude value
#' 
#' Return a TRUE value is the input parameter is a valid longitude value,
#' FALSE otherwise
#' 
#' @param longitude a longitude coordinate value
#' 
#' @examples
#' #' # return a true value
#' is.longitude(40)
#' 
#' # return a false value
#' is.longitude(200)
#' 
#' @rdname is.longitude
#' @export is.longitude
#' @aliases is.longitude
is.longitude <- function(longitude) {
  if (is.numeric(longitude)) {
    if(longitude >= -180 && longitude <= 180) {
      return(TRUE)
    } else {
      return(FALSE)
    }
  } else {
    return(FALSE)
  }
}