README.md 1.28 KB
Newer Older
Ahmad Alkadri's avatar
Ahmad Alkadri committed
1 2
R-Terahertz
================
Ahmad Alkadri's avatar
Ahmad Alkadri committed
3

Ahmad Alkadri's avatar
Ahmad Alkadri committed
4 5 6 7
This is an R package containing many functions used for working with
Terahertz scanning/imaging data. This package is licensed under MIT
License. The current main contributors, direct and indirect, of this
package are:
Ahmad Alkadri's avatar
Ahmad Alkadri committed
8

Ahmad Alkadri's avatar
Ahmad Alkadri committed
9 10 11 12 13 14
  - Ahmad Alkadri (<ahmad.alkadri@umontpellier.fr>)
  - Olivier Arnould
  - Delphine Jullien
  - Joseph Gril
  - Dominique Coquillat
  - Nina Dyakonova
Ahmad Alkadri's avatar
Ahmad Alkadri committed
15

Ahmad Alkadri's avatar
Ahmad Alkadri committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
This package is constantly under development for now. We’re still
actively working with the Terahertz technique. Active developments and
updates will be made regularly. Any further questions should be directed
by e-mail to <ahmad.alkadri@umontpellier.fr>.

## How to install

For installing the package on your computer, simply open your R (via
console or IDE such as RStudio) and type:

    devtools::install_git(
      "https://git-xen.lmgc.univ-montp2.fr/alkadri/rterahertz.git", 
      credentials = git2r::cred_user_pass("user.name", getPass::getPass())
    )

Where **user.name** is the email address that you use for logging in to
<https://git-xen.lmgc.univ-montp2.fr/>. Once you run that, you will be
prompted to enter your password that you usually use to logging in to
LMGC’s git. Don’t forget, you need to have *devtools*, *git2r*, and
*getPass* packages installed on your R in your computer.