APCtools

APCtools: Descriptive and Model-based Age-Period-Cohort Analysis - Published in JOSS (2022)

https://github.com/bauer-alex/apctools

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 12 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: researchgate.net, joss.theoj.org
  • Committers with academic emails
    3 of 5 committers (60.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Engineering Computer Science - 40% confidence
Last synced: 6 months ago · JSON representation

Repository

Descriptive and model-based tools for Age-Period-Cohort analyses

Basic Info
  • Host: GitHub
  • Owner: bauer-alex
  • License: other
  • Language: R
  • Default Branch: main
  • Homepage:
  • Size: 42.8 MB
Statistics
  • Stars: 15
  • Watchers: 2
  • Forks: 3
  • Open Issues: 4
  • Releases: 1
Created over 4 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License

README.Rmd

---
output: github_document
---

```{r options, echo=FALSE}
library(knitr)
opts_chunk$set(warning=FALSE)
```

# APCtools 


[![R build status](https://github.com/bauer-alex/APCtools/workflows/R-CMD-check/badge.svg)](https://github.com/bauer-alex/APCtools/actions)
[![Codecov test coverage](https://codecov.io/gh/bauer-alex/APCtools/branch/main/graph/badge.svg?token=KrjDYWRi2W)](https://app.codecov.io/gh/bauer-alex/APCtools)
[![](https://cranlogs.r-pkg.org/badges/grand-total/APCtools)](https://cran.r-project.org/package=APCtools)
[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)


Routines for Descriptive and Model-Based APC Analysis

* Authors: [Alexander Bauer](https://github.com/bauer-alex), Maximilian Weigert, [Hawre Jalal](https://www.uottawa.ca/faculty-medicine/dr-hawre-jalal)
* Version: 1.0.8


## Aim of this Package

Age-Period-Cohort (APC) analysis aims to determine relevant drivers for
long-term developments and is used in many fields of science.
The main focus is on disentangling the interconnected effects of age, period, and
cohort.
Long-term developments of some characteristic can either be associated
with changes in a person's life cycle (age), macro-level developments over the years
that simultaneously affect all age groups (period), or the generational
membership of an individual, shaped by similar socialization processes and historical experiences
(cohort).
The critical challenge in APC analysis is the linear dependency of the
components age, period, and cohort (cohort = period - age).
Accordingly, flexible methods and visualization techniques are needed to properly
disentangle observed temporal association structures.

In contrast to other software packages, `APCtools` builds on a flexible and robust
semiparametric regression approach to circumvent this identification problem.
The package includes modern visualization techniques and general routines to facilitate
the interpretability of the estimated temporal structures and simplify the workflow
of an APC analysis.


## Main Functionality

Sophisticated functions are available both for descriptive and regression model-based analyses.
For the former, we use density (or ridgeline) matrices, classical heatmaps and
*hexamaps* (hexagonally binned heatmaps) as innovative visualization techniques
building on the concept of Lexis
diagrams. Model-based analyses build on the separation of the temporal dimensions
based on generalized additive models, where a tensor product interaction surface
(usually between age and period) is utilized to represent the third dimension
(usually cohort) on its diagonal. Such tensor product surfaces can also be
estimated while accounting for further covariates in the regression model.

## Documentation and Useful Materials

* To get an overview of the functionalities of the package, check out the
[JOSS publication](https://joss.theoj.org/papers/10.21105/joss.04056) or the
[package vignette](https://bauer-alex.github.io/APCtools/articles/main_functionality.html).

* See [Weigert et al. (2021)](https://doi.org/10.1177/1354816620987198) or
our corresponding [research poster](https://www.researchgate.net/publication/353852226_Visualization_techniques_for_semiparametric_APC_analysis_Using_Generalized_Additive_Models_to_examine_touristic_travel_distances)
for methodological details.
    
* Hexamaps as a concept for the visualization of APC structures are outlined in
[Jalal & Burke (2020)](https://doi.org/10.1097/EDE.0000000000001236).


## Installation

The most current version from GitHub can be installed via
```{r, eval=FALSE}
devtools::install_github("bauer-alex/APCtools")
```


## How to Contribute

If you encounter problems with the package, find bugs or have suggestions for
additional functionalities please open a
[GitHub issue](https://github.com/bauer-alex/APCtools/issues).
Alternatively, feel free to contact us directly via email.

Contributions (via pull requests or otherwise) are welcome.
Before you open a pull request or share your updates with us, please make sure
that all unit tests pass without errors or warning messages. You can run the unit
tests by calling
```r
devtools::test()
```

## References

Bauer, A., Weigert, M., and Jalal, H. (2022). APCtools: Descriptive and Model-based Age-Period-Cohort Analysis. Journal of Open Source Software, 7(73), 4056, https://doi.org/10.21105/joss.04056.

Weigert, M., Bauer, A., Gernert, J., Karl, M., Nalmpatian, A., Küchenhoff, H.,
and Schmude, J. (2021). Semiparametric APC analysis of destination choice
patterns: Using generalized additive models to quantify the impact of age,
period, and cohort on travel distances. *Tourism Economics*.
https://doi.org/10.1177/1354816620987198.

Jalal, H., Burke, D. (2020). Hexamaps for Age–Period–Cohort Data Visualization
and Implementation in R. *Epidemiology*, 31 (6), e47-e49. doi: https://doi.org/10.1097/EDE.0000000000001236.

Owner

  • Name: Alexander Bauer
  • Login: bauer-alex
  • Kind: user

JOSS Publication

APCtools: Descriptive and Model-based Age-Period-Cohort Analysis
Published
May 04, 2022
Volume 7, Issue 73, Page 4056
Authors
Alexander Bauer ORCID
Statistical Consulting Unit StaBLab, Department of Statistics, LMU Munich, Germany
Maximilian Weigert ORCID
Statistical Consulting Unit StaBLab, Department of Statistics, LMU Munich, Germany
Hawre Jalal ORCID
Department of Health Policy and Management, Graduate School of Public Health, University of Pittsburgh.
Editor
Nikoleta Glynatsi ORCID
Tags
Statistical analysis APC analysis Age period cohort analysis Hexamaps

GitHub Events

Total
  • Watch event: 2
  • Issue comment event: 4
  • Push event: 5
Last Year
  • Watch event: 2
  • Issue comment event: 4
  • Push event: 5

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 239
  • Total Committers: 5
  • Avg Commits per committer: 47.8
  • Development Distribution Score (DDS): 0.222
Past Year
  • Commits: 4
  • Committers: 1
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
bauer-alex a****r@s****e 186
ri87nix m****t@s****e 46
bauer-alex a****3@p****e 5
Pauline Hohenemser p****e@M****x 1
Alexander Bauer A****r@s****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 20
  • Total pull requests: 1
  • Average time to close issues: 2 months
  • Average time to close pull requests: about 23 hours
  • Total issue authors: 7
  • Total pull request authors: 1
  • Average comments per issue: 1.7
  • Average comments per pull request: 1.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: about 22 hours
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 2.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • MaxWeigert (6)
  • bauer-alex (6)
  • strengejacke (3)
  • jaybee84 (2)
  • teunbrand (1)
  • mtp354 (1)
  • tamas-ferenci (1)
Pull Request Authors
  • rickmer-schulte (1)
Top Labels
Issue Labels
bug (2) enhancement (2) feature request (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 438 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
cran.r-project.org: APCtools

Routines for Descriptive and Model-Based APC Analysis

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 438 Last month
Rankings
Forks count: 14.9%
Stargazers count: 19.8%
Average: 26.6%
Dependent packages count: 29.8%
Downloads: 33.3%
Dependent repos count: 35.5%
Maintainers (1)
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5 depends
  • checkmate * imports
  • colorspace * imports
  • dplyr * imports
  • ggplot2 * imports
  • ggpubr * imports
  • knitr * imports
  • mgcv * imports
  • scales * imports
  • tidyr * imports
  • covr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite