{"id":13605585,"url":"https://github.com/r-hyperspec/hyperSpec","last_synced_at":"2025-04-12T05:33:42.712Z","repository":{"id":41850452,"uuid":"385993653","full_name":"r-hyperspec/hyperSpec","owner":"r-hyperspec","description":"hyperSpec: Tools for Spectroscopy (R package)","archived":false,"fork":false,"pushed_at":"2024-05-27T17:10:41.000Z","size":112005,"stargazers_count":16,"open_issues_count":34,"forks_count":4,"subscribers_count":8,"default_branch":"develop","last_synced_at":"2025-03-05T14:17:09.645Z","etag":null,"topics":["data-wrangling","hyperspectral","imaging","infrared","nmr","r-package","raman","spectroscopy","uv-vis","xrf"],"latest_commit_sha":null,"homepage":"https://r-hyperspec.github.io/hyperSpec/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/r-hyperspec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-14T15:47:53.000Z","updated_at":"2025-01-29T21:52:14.000Z","dependencies_parsed_at":"2024-03-07T10:41:28.523Z","dependency_job_id":"66e1892c-da4c-43ce-8fff-b62fb47444f9","html_url":"https://github.com/r-hyperspec/hyperSpec","commit_stats":{"total_commits":465,"total_committers":7,"mean_commits":66.42857142857143,"dds":0.09892473118279566,"last_synced_commit":"344e992d88322353afb771ff7788162d48b66967"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-hyperspec%2FhyperSpec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-hyperspec%2FhyperSpec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-hyperspec%2FhyperSpec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-hyperspec%2FhyperSpec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/r-hyperspec","download_url":"https://codeload.github.com/r-hyperspec/hyperSpec/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248312131,"owners_count":21082638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-wrangling","hyperspectral","imaging","infrared","nmr","r-package","raman","spectroscopy","uv-vis","xrf"],"created_at":"2024-08-01T19:01:00.482Z","updated_at":"2025-04-12T05:33:41.381Z","avatar_url":"https://github.com/r-hyperspec.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"\u003c!-- ---------------------------------------------------------------------- --\u003e\n\n\u003c!-- badges: start --\u003e\n[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![CRAN status](https://www.r-pkg.org/badges/version-last-release/hyperSpec)](https://cran.r-project.org/package=hyperSpec)\n[![metacran downloads](https://cranlogs.r-pkg.org/badges/grand-total/hyperSpec)](https://cran.r-project.org/package=hyperSpec)\n[![metacran downloads](https://cranlogs.r-pkg.org/badges/hyperSpec)](https://cran.r-project.org/package=hyperSpec)\n[![R-CMD-check](https://github.com/r-hyperspec/hyperSpec/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-hyperspec/hyperSpec/actions/workflows/R-CMD-check.yaml)\n[![Codecov](https://codecov.io/gh/r-hyperspec/hyperSpec/branch/develop/graph/badge.svg)](https://codecov.io/gh/r-hyperspec/hyperSpec?branch=develop)\n[![Website (pkgdown)](https://github.com/r-hyperspec/hyperSpec/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/r-hyperspec/hyperSpec/actions/workflows/pkgdown.yaml)\n\u003c!-- [![license](https://img.shields.io/badge/license-GPL--3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html) --\u003e\n\u003c!-- badges: end --\u003e\n\n\n\n\u003c!-- ---------------------------------------------------------------------- --\u003e\n# R Package **hyperSpec**\n\u003c!-- ---------------------------------------------------------------------- --\u003e\n\u003cbr\u003e\n\u003ccenter\u003e\n\u003cfont color=\"red\" size=4\u003e\n\u003cb\u003ePackage `hyperSpec` is under overhaul now.\u003c/b\u003e  \nSo this website is still under construction and the contents as well as resources are not fully updated yet.  \nThe documentation of version \u003ccode\u003e0.100.2\u003c/code\u003e is not present here either.\n\u003c/font\u003e\n\u003c/center\u003e\n\u003cbr\u003e\n\u003c!-- ---------------------------------------------------------------------- --\u003e\n\n\n[**R**](https://www.r-project.org/) package **hyperSpec** is the main package in the [**`r-hyperspec`**](https://r-hyperspec.github.io/) family of packages.\nThe goal of **hyperSpec** (and whole **`r-hyperspec`**) is to make the work with hyperspectral data sets, (i.e. spatially or time-resolved spectra, or spectra with any other kind of information associated with each of the spectra) more comfortable.\nThe spectra can be data obtained during \n[XRF](https://en.wikipedia.org/wiki/X-ray_fluorescence),\n[UV/VIS](https://en.wikipedia.org/wiki/Ultraviolet%E2%80%93visible_spectroscopy), \n[Fluorescence](https://en.wikipedia.org/wiki/Fluorescence_spectroscopy),\n[AES](https://en.wikipedia.org/wiki/Auger_electron_spectroscopy),\n[NIR](https://en.wikipedia.org/wiki/Near-infrared_spectroscopy),\n[IR](https://en.wikipedia.org/wiki/Infrared_spectroscopy), \n[Raman](https://en.wikipedia.org/wiki/Raman_spectroscopy), \n[NMR](https://en.wikipedia.org/wiki/Nuclear_magnetic_resonance_spectroscopy), \n[MS](https://en.wikipedia.org/wiki/Mass_spectrometry),\netc. spectroscopy measurements.\nMore generally, any data that is recorded over a discretized variable, e.g. `absorbance = f(wavelength)`, stored as a vector of absorbance values for discrete wavelengths is suitable.\n\n\n\u003c!-- ---------------------------------------------------------------------- --\u003e\n\n## Documentation\n\nThere are two versions of **hyperSpec** online documentation:\n\na. for the [released version](https://r-hyperspec.github.io/hyperSpec/) and\nb. for the [in-development version](https://r-hyperspec.github.io/hyperSpec/dev/) of **hyperSpec**.\n\nThe documentation of the other **`r-hyperspec`** family packages can be found at [r-hyperspec.github.io](https://r-hyperspec.github.io/).\n\n\u003c!-- ---------------------------------------------------------------------- --\u003e\n\n## Issues, Bug Reports and Feature Requests\n\nIssues, bug reports, and feature requests should go [here](https://github.com/r-hyperspec/hyperSpec/issues)!\n\u003c!-- ---------------------------------------------------------------------- --\u003e\n\n\n## Installation\n\n### Install from CRAN\n\nYou can install the **released** version of **hyperSpec** from [CRAN](https://cran.r-project.org/package=hyperSpec) with:\n\n```r\ninstall.packages(\"hyperSpec\")\n```\n\n\n### Install from CRAN-like Repository\n\nThe **recommended** way to install the in-development version:\n\n```r\nrepos \u003c- c(\"https://r-hyperspec.github.io/pkg-repo/\", getOption(\"repos\"))\ninstall.packages(\"hyperSpec\", repos = repos)\n```\n\n### Install from GitHub\n\n\u003cdetails\u003e\n\u003csummary\u003eInstall from GitHub (details)\u003c/summary\u003e\n\nYou can install the in-development version of the package from [GitHub](https://github.com/r-hyperspec/hyperSpec) too:\n\n```r\nif (!require(remotes)) {install.packages(\"remotes\")}\nremotes::install_github(\"r-hyperspec/hyperSpec\")\n```\n\n**NOTE 1:**\nUsually, \"Windows\" users need to download, install, and properly configure **Rtools** (see [these instructions](https://cran.r-project.org/bin/windows/Rtools/)) to make the code above work.\n\n**NOTE 2:**\nThis method will **not** install package's documentation (help pages and vignettes) into your computer.\nSo you can either use the [online documentation](https://r-hyperspec.github.io/) or build the package from source (see the next section).\n\n\u003c/details\u003e\n\n\n\n### Install from Source\n\n\u003cdetails\u003e\n\u003csummary\u003eInstall from Source (details)\u003c/summary\u003e\n\n\n1. From the **hyperSpec**'s GitHub [repository](https://github.com/r-hyperspec/hyperSpec):\n    - If you use Git, `git clone` the branch of interest.\n      You may need to fork it before cloning.\n    - Or just choose the branch of interest (1 in Figure below), download a ZIP archive with the code (2, 3), and unzip it on your computer.  \n![image](https://user-images.githubusercontent.com/12725868/89338263-ffa1dd00-d6a4-11ea-94c2-fa36ee026691.png)\n\n2. Open the downloaded directory in RStudio (preferably, as an RStudio project).\n    - The code below works correctly only if your current working directory coincides with the root of the repository, i.e., if it is in the directory that contains file `README.md`.\n    - If you open RStudio project correctly (e.g., by clicking `project.Rproj` icon ![image](https://user-images.githubusercontent.com/12725868/89340903-26621280-d6a9-11ea-8299-0ec5e9cf7e3e.png) in the directory), then the working directory is set correctly by default.\n\n3. In the RStudio 'Console' window, run the code (provided below) to:\n    a. Install packages **remotes** and **devtools**.\n    b. Install **hyperSpec**'s dependencies.\n    c. Create **hyperSpec**'s documentation.\n    d. Install package **hyperSpec**.\n\n```r\n# Do not abort installation even if some packages are not available\nSys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS = \"true\")\n\n# Install packages remotes and devtools\ninstall.packages(c(\"remotes\", \"devtools\"))\n\n# Install hyperSpec's dependencies\nremotes::install_deps(dependencies = TRUE)\n\n# Create hyperSpec's documentation\ndevtools::document()\n\n# Install package hyperSpec\ndevtools::install(build_vignettes = TRUE)\n```\n\n**NOTE 1:**\nUsually, \"Windows\" users need to download, install, and properly configure **Rtools** (see [these instructions](https://cran.r-project.org/bin/windows/Rtools/)) to make the code above work.\n\n\u003c/details\u003e\n\n\n## For Developers\n\nDevelopers can find information about automatic deployment from this repo to `pkg-repo` [here](https://github.com/r-hyperspec/pkg-repo) in `CONTRIBUTING.md`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-hyperspec%2FhyperSpec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr-hyperspec%2FhyperSpec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-hyperspec%2FhyperSpec/lists"}