Skip to content

Commit

Permalink
clean up description + citation
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherkenny committed Feb 22, 2024
1 parent 9250f22 commit efad21f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 9 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: planscorer
Title: Score Redistricting Plans with PlanScore
Title: Score Redistricting Plans with 'PlanScore'
Version: 0.0.1
Authors@R: c(
person(given = "Christopher T.",
Expand All @@ -15,7 +15,7 @@ Authors@R: c(
family = "McCartan",
role = "art")
)
Description: Provides access to the PlanScore Application Programming Interface
Description: Provides access to the 'PlanScore' Application Programming Interface
(<https://github.com/PlanScore/PlanScore/blob/main/API.md>) for scoring redistricting
plans. Allows for upload of plans from block assignment files and shape files.
For shapes in memory, such as from 'sf' or 'redist', it processes them to save
Expand Down
28 changes: 21 additions & 7 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
citHeader("To cite planscorer in publications use:")

citEntry(
entry = "misc",
title = 'PlanScore',
year = 2022,
url = 'planscore.org',
note = '',
textVersion = 'PlanScore. 2022. planscore.org.'
bibentry(
bibtype = "Manual",
title = "{planscorer}: Score Redistricting Plans with PlanScore",
author = c(
person(given = "Christopher T.",
family = "Kenny",
role = c("aut", "trl", "cre"),
email = "christopherkenny@fas.harvard.edu",
comment = c("R port", ORCID = "0000-0002-9386-6860")),
person(given = "Michal",
family = "Migurski",
role = c("aut"),
comment = c("python original, https://github.com/PlanScore/PlanScore-CLI")),
person(given = "Cory",
family = "McCartan",
role = "art")
),
year = "2024",
note = "R package",
key = "planscorer",
url = "https://christophertkenny.com/planscorer/"
)

0 comments on commit efad21f

Please sign in to comment.