Giter VIP home page Giter VIP logo

coordgeomr's Introduction

CoordGeomR

R-CMD-check codecov

A simple coordinate geometry helper package. This package is developed for the UBC MDS DSCI 524 Collaborative Software Development course at the University of British Columbia.

Overview

This starter package allows users to perform various geometric operations like calculate distance between two parallel lines, distance between two n dimensional vectors, intersection of lines in 3-Dimensional space and determine if two infinite lines are perpendicular in n-dimensional space. Our motivation in creating this package was to allow users with minimal experience in R programming to be able to perform these geometric calculations easily.

While we are not really reinventing the wheel on coordinate geometry calculations with our package, we used this as an opportunity to gain some experience in understanding how these calculations function in the R ecosystem. There is an existing package called LearnGeom that executes similar functions. For example, the package has functions like DistanceLines that computes distance between two lines and IntersectLines which finds the intersection of two lines.

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("UBC-MDS/CoordGeomR")

Example

This is a basic example which shows you how to solve a common problem:

library(CoordGeomR)
x1 <- c(1, 2, 3, 4)
x2 <- c(5, 6, 7, 8)
get_distance <- function(x1, x2, metric="Euclidean")

Further usage examples can be found in our documentation. See our full package documentation here: https://ubc-mds.github.io/CoordGeomR/

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

Contributors

We welcome and recognize all contributors. Names and GitHub @usernames listed below:

  • Arlin Cherian: @arlincherian
  • Nico Van Den Hooff: @nicovandenhooff
  • Zheren Xu: @ZherenXu
  • Jordan Casoli: @jcasoli

License

CoordGeomR is licensed under the terms of the License: MIT

coordgeomr's People

Contributors

jcasoli avatar arlincherian avatar nicovandenhooff avatar zherenxu avatar

Watchers

James Cloos avatar  avatar

Forkers

arlincherian

coordgeomr's Issues

Package documentation & package website

Your package documentation should be very clear by the end of this milestone. To do this, you should use vignette package-wide documentation in R, as well as the pkgdown R package to set up a website for your package. In doing this make sure you:

include a full usage demonstration of all your package functions (this means a runnable example - give them data!) in your vignette

include installation instructions in the README.Rmd file

examine Roxygen2 documentation of your functions to make sure it is clear

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.