Skip to content

Commit

Permalink
update website and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bcallaway11 committed Jan 31, 2025
1 parent e3b397b commit 3baca52
Show file tree
Hide file tree
Showing 65 changed files with 2,397 additions and 3,370 deletions.
23 changes: 20 additions & 3 deletions .github/workflows/update-citation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,28 @@ jobs:
run: |
Rscript -e '
library(desc);
d <- desc::desc_get();
citation_text <- sprintf("citHeader(\"To cite this package, use:\")\n\nbibentry(\n bibtype = \"Manual\",\n title = \"%s\",\n author = %s,\n year = \"%s\",\n note = \"R package version %s\",\n url = \"%s\"\n)",
d["Title"], d["Authors@R"], format(Sys.Date(), "%Y"), d["Version"], d["URL"]);
# Read package metadata
package_title <- desc::desc_get("Title")
authors <- desc::desc_get("Authors@R")
version <- desc::desc_get("Version")
url <- desc::desc_get("URL")
year <- format(Sys.Date(), "%Y") # Get current year
# Generate citation content dynamically
citation_text <- sprintf("citHeader(\"To cite this package, use:\")\n\n
bibentry(\n
bibtype = \"Manual\",\n
title = \"%s\",\n
author = %s,\n
year = \"%s\",\n
note = \"R package version %s\",\n
url = \"%s\"
)", package_title, authors, year, version, url)
# Write the updated citation file
writeLines(citation_text, "inst/CITATION")'
- name: Update CITATION.cff
run: |
Rscript -e 'cffr::cff_write()'
Expand Down
40 changes: 17 additions & 23 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
# --------------------------------------------

cff-version: 1.2.0
message: 'To cite package "pte" in publications use:'
message: 'To cite package "ptetools" in publications use:'
type: software
license: GPL-3.0-only
title: 'pte: Panel Treatment Effects'
version: 0.0.0.9000
title: 'ptetools: Panel Treatment Effects Tools'
version: 1.0.0
abstract: This is fairly generic code for estimating treatment effects with panel
data. This is useful code in my own work and will perhaps be useful to others. It
builds heavily on the \codedid package. In particular, it breaks into separate steps
Expand All @@ -21,8 +21,18 @@ authors:
- family-names: Callaway
given-names: Brantly
email: [email protected]
repository-code: https://github.com/bcallaway11/pte
url: https://github.com/bcallaway11/pte
preferred-citation:
type: manual
title: Panel Treatment Effects Tools
authors:
- family-names: Callaway
given-names: Brantly
email: [email protected]
year: '2025'
notes: R package version 1.0.0
url: https://github.com/bcallaway11/ptetools
repository-code: https://github.com/bcallaway11/ptetools
url: https://github.com/bcallaway11/ptetools
contact:
- family-names: Callaway
given-names: Brantly
Expand All @@ -41,12 +51,12 @@ references:
email: [email protected]
year: '2025'
doi: 10.32614/CRAN.package.BMisc
version: '>= 1.4.1'
version: '>= 1.4.7'
- type: software
title: Matrix
abstract: 'Matrix: Sparse and Dense Matrix Classes and Methods'
notes: Imports
url: https://R-forge.R-project.org/tracker/?atid=294&group_id=61
url: https://Matrix.R-forge.R-project.org
repository: https://CRAN.R-project.org/package=Matrix
authors:
- family-names: Bates
Expand All @@ -61,22 +71,6 @@ references:
orcid: https://orcid.org/0000-0002-3542-2938
year: '2025'
doi: 10.32614/CRAN.package.Matrix
- type: software
title: did
abstract: 'did: Treatment Effects with Multiple Periods and Groups'
notes: Imports
url: https://bcallaway11.github.io/did/
repository: https://CRAN.R-project.org/package=did
authors:
- family-names: Callaway
given-names: Brantly
email: [email protected]
- family-names: Sant'Anna
given-names: Pedro H. C.
email: [email protected]
year: '2025'
doi: 10.32614/CRAN.package.did
version: '>= 2.0.0'
- type: software
title: ggplot2
abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
Expand Down
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Authors@R:
role = c("aut", "cre"),
email = "[email protected]")
URL: https://github.com/bcallaway11/ptetools
BugReports: https://github.com/bcallaway11/ptetools/issues
Description: This is fairly generic code for estimating treatment effects with panel data. This is useful code in my own work and will perhaps be useful to others. It builds heavily on the \code{did} package. In particular, it breaks into separate steps organizing the data, looping over groups and time periods, computing group-time average treatment effects, and aggregating group-time average treatment effects. Often, one is able to implement a new identification/estimation procedure by simply replacing the step on estimating group-time average treatment effects. See several different examples of this approach in the README.
License: GPL-3
Encoding: UTF-8
Expand Down
4 changes: 3 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ output: github_document
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
fig.path = "man/figures/README-",
warning = FALSE,
message = FALSE
)
```

Expand Down
Loading

0 comments on commit 3baca52

Please sign in to comment.