Data

Tools

Indexes

Applications

Experiments

Open Source Science

LocalCop

LocalCop: An R package for local likelihood inference for conditional copulas - Published in JOSS (2024)

https://github.com/mlysy/localcop

Science Score: 93.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 1 DOI reference(s) in JOSS metadata
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

Local Likelihood Inference for Conditional Copulas

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 2
  • Open Issues: 1
  • Releases: 0
Created almost 7 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
---



```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
library(desc)

#' Parse and format author list.
#'
#' @details Only those with roles "aut" and "cre" are included.
get_authors <- function() {
  authors_full <- eval(parse(text = desc_get("Authors@R")))
  is_aut <- sapply(authors_full,
                   function(x) any(x$role %in% c("aut", "cre")))
  authors <- format(authors_full[is_aut],
                    include = c("given", "family"))
  paste0(authors, collapse = ", ")
}

#' Format description.
#'
#' @details Converts TMB package names to hyperlink.
get_description <- function() {
  desc_text <- desc_get("Description")
  desc_text <- gsub("'TMB'",
                    replacement = "[**TMB**](https://github.com/kaskr/adcomp)",
                    x = desc_text)
  desc_text
}

#' Create the CRAN installation instructions.
#'
#' @details If package is found on CRAN, provide [install.packages()] command and version number.  Otherwise do nothing.
cran_install <- function() {
  pkg_name <- desc_get("Package")
  # check if cran version exists
  cran_pkgs <- available.packages(filter = "CRAN")
  if(pkg_name %in% cran_pkgs[,"Package"]) {
    pkg_info <- cran_pkgs[pkg_name,]
    cat(
      paste0("To install the CRAN version (", pkg_info["Version"], "):"),
      "",
      "```r",
      paste0('install.packages("', pkg_name,
             '", INSTALL_opts = "--install-tests")'),
      "```",
      "",
      sep = "\n"
    )
  }
}

#' Create the GitHub install command.
github_install <- function() {
  pkg_name <- desc_get("Package")
  cat(
    "```r",
    paste0('devtools::install_github("mlysy/', pkg_name,
           '", INSTALL_opts = "--install-tests")'),
    "```",
    sep = "\n"
  )
}

#' Create call to package vignette.
get_vignette <- function(name) {
  if(missing(name)) name <- desc_get("Package")
  paste0('`vignette("', name, '")`')
}

#' Create call to run testthat.
get_tests <- function() {
  pkg_name <- desc_get("Package")
  cat(
    "```r",
    paste0('testthat::test_package("', pkg_name,
           '", reporter = "progress")'),
    "```",
    sep = "\n"
  )
}

#' Create issue link.
get_issue <- function() {
  pkg_name <- desc_get("Package")
  paste0("[issue](https://github.com/mlysy/", pkg_name, "/issues)")
}
```

# `r desc_get("Package")`: `r desc_get("Title")`

*`r get_authors()`*


[![R-CMD-check](https://github.com/mlysy/LocalCop/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mlysy/LocalCop/actions/workflows/R-CMD-check.yaml)


---

### Description

`r get_description()`


### Installation

```{r cran-install, echo = FALSE, results = "asis"}
cran_install()
```

To install the latest development version: first install the [**devtools**](https://CRAN.R-project.org/package=devtools) package, then:

```{r github-install, echo = FALSE, results = "asis"}
github_install()
```

### Usage

Please see package vignette: `r get_vignette("LocalCop-vignette")`.

### Unit Tests

To verify that the package has been installed correctly, you can run its unit tests.  First install the [**testthat**](https://CRAN.R-project.org/package=testthat) package, then:

```{r unit-tests, echo = FALSE, results = "asis"}
get_tests()
```

### Contributing

Contributions in the form of bug reports, fixes, extensions, improvements, etc. are most welcome.  Please file an `r get_issue()` before submitting a PR.

Owner

  • Login: mlysy
  • Kind: user
  • Company: University of Waterloo

Martin Lysy

JOSS Publication

LocalCop: An R package for local likelihood inference for conditional copulas
Published
September 25, 2024
DOI
Volume 9, Issue 101, Page 6744
Authors
Elif Fidan Acar ORCID
University of Guelph, Hospital for Sick Children
Martin Lysy ORCID
University of Waterloo
Alan Kuchinsky
University of Manitoba
Editor
Oskar Laverny ORCID
Tags
copula local likelihood covariate effect
View PDF Review Thread Software Archive

GitHub Events

Total
  • Pull request review event: 9
  • Pull request review comment event: 14
  • Pull request event: 2
Last Year
  • Pull request review event: 9
  • Pull request review comment event: 14
  • Pull request event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 83
  • Total Committers: 3
  • Avg Commits per committer: 27.667
  • Development Distribution Score (DDS): 0.277
Past Year
  • Commits: 10
  • Committers: 1
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
mlysy m****y 60
EFAcar 2****r 22
alank2004 a****y@g****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 17
  • Average time to close issues: 21 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 2.25
  • Average comments per pull request: 0.06
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 5
  • Average time to close issues: 29 days
  • Average time to close pull requests: 15 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 1.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • AlexisDerumigny (2)
  • mingzehuang (2)
Pull Request Authors
  • mlysy (19)
  • EFAcar (7)
  • alank2004 (6)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 164 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: LocalCop

Local Likelihood Inference for Conditional Copula Models

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 164 Last month
Rankings
Dependent packages count: 28.1%
Dependent repos count: 36.0%
Average: 49.7%
Downloads: 84.9%
Maintainers (1)
mlysy@uwaterloo.ca
Last synced: 6 months ago