{"id":18921064,"url":"https://github.com/tzerk/gammaspec","last_synced_at":"2025-04-15T11:31:37.006Z","repository":{"id":83624039,"uuid":"61302690","full_name":"tzerk/gammaSpec","owner":"tzerk","description":"A collection of functions to analyse gamma spectra","archived":false,"fork":false,"pushed_at":"2022-09-20T13:11:21.000Z","size":668,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T20:37:30.884Z","etag":null,"topics":["data-analysis","gamma-ray-spectrometry","r"],"latest_commit_sha":null,"homepage":null,"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/tzerk.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS","contributing":null,"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":"2016-06-16T14:56:47.000Z","updated_at":"2025-03-17T20:06:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"166384a1-24c6-4be3-9498-d8a077d4a434","html_url":"https://github.com/tzerk/gammaSpec","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzerk%2FgammaSpec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzerk%2FgammaSpec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzerk%2FgammaSpec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzerk%2FgammaSpec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tzerk","download_url":"https://codeload.github.com/tzerk/gammaSpec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249061034,"owners_count":21206441,"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-analysis","gamma-ray-spectrometry","r"],"created_at":"2024-11-08T10:45:09.525Z","updated_at":"2025-04-15T11:31:37.000Z","avatar_url":"https://github.com/tzerk.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\"\n)\n\n## Examples\nlibrary(gammaSpec)\nfile \u003c- system.file(\"extdata\", \"Nievenheim_DORNIE_1.spe\", package = \"gammaSpec\")\n``` \n\n# gammaSpec \u003ca href='https://tzerk.github.io/gammaSpec/'\u003e\u003cimg src='man/figures/logo.png' align=\"right\" height=\"138.5\" /\u003e\u003c/a\u003e\n\n\u003c!-- badges: start --\u003e\n[![Build Status](https://travis-ci.org/tzerk/gammaSpec.svg?branch=master)](https://travis-ci.org/tzerk/gammaSpec)\n[![Build status](https://ci.appveyor.com/api/projects/status/kgrhm1tni43qohm1?svg=true)](https://ci.appveyor.com/project/tzerk/gammaspec)\n\u003c!-- badges: end --\u003e\n\n\u003e [Find a full documentation of the package on the project page](https://tzerk.github.io/gammaSpec/)\n\n## Overview\n\nThe **R** package 'gammaSpec' provides a small collection of functions to analyse\ngamma spectra of NaI(Tl) scintillation radiation detectors.\n\n## Installation\n\nThe ‘gammaSpec’ package is not available on the official CRAN servers.\n\nHowever, the latest development builds can directly be installed from GitHub. Simply run the following from an R console\n\n```{r, eval = FALSE}\nif(!require(\"devtools\"))\n  install.packages(\"devtools\")\ndevtools::install_github(\"tzerk/gammaSpec\")\n```\n\n## Features\n\n### Data import\n\nThe function `read_SPE()` can be used to import SPE files produces by the\nORTEC application software 'MAESTRO Mulichannel Analyzer Emulation' and \n'GammaVision Gamma Spectroscopy'. All meta information in the SPE files \nare preserved in the return object.\n\n```{r, eval = FALSE}\nfile \u003c- read_SPE(file = \"~/path/to/file.spe\")\n```\n\n\n```{r, warning=FALSE}\nspectrum \u003c- read_SPE(file)\nstr(spectrum, max.level = 1)\n```\n\n### Plotting\n\nThe package contains a custom S3 method for `plot()` to quickly visualise the\nimported spectrum. It further offers to re-calculate the absolute counts per \nchannel to a count rate per energy (keV).\n\n```{r spec_plot, warning = FALSE}\nplot(spectrum, \n     type = c(\"bar\", \"line\", \"point\")[2],\n     xval = c(\"energy\", \"channel\")[1], \n     yval = c(\"rate\", \"count\")[1],\n     info = TRUE, fill = FALSE)\n```\n\n\n\n### Estimating the gamma dose rate\n\nThe function `calc_DoseRate()` estimates the in-situ gamma dose rate of the\nprovided gamma spectrum based on the recorded count rate and comparing the\nintegrated sum within a user specified energy range to that of an \ninternal calibration spectrum.\n\n```{r doserate, fig.height=10, fig.width=7}\nres \u003c- calc_DoseRate(data = spectrum,\n                     energy.min = 500,\n                     energy.max = 2600,\n                     background.correction = TRUE,\n                     plot = TRUE,\n                     plot.combine = TRUE,\n                     app = FALSE,\n                     cex = 0.8)\n```\n\n### Shiny application\n\nFinally, the package includes a simple [shiny](https://github.com/rstudio/shiny) \napplication.\n\n```{r, eval = FALSE}\ncalc_DoseRate(app = TRUE)\n```\n\n\n![app](man/figures/app.png)\n\n\n## Note\nThis version is a development version and it comes without any guarentee!\n\n## License\n\nThe gammaSpec package is licensed under the GPLv3. See these files in the main directory for additional details:\n\n* LICENSE - gammaSpec package license (GPLv3)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzerk%2Fgammaspec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftzerk%2Fgammaspec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzerk%2Fgammaspec/lists"}