Merge pull request #40 from bretsw/dev

added CITATION file

DESCRIPTION

@@ -1,6 +1,7 @@
 Package: tidytags
-Version: 0.1.3
 Title: Importing and Analyzing Twitter Data Collected with Twitter Archiving Google Sheets
+Version: 0.2.0
+License: GPL-3
 Authors@R: c(
     person("K. Bret", "Staudt Willet", , 
       email = "[email protected]", 
@@ -26,7 +27,6 @@ Description: The {tidytags} package coordinates the simplicity of collecting twe
     for processing and preparing additional Twitter metadata. {tidytags} also 
     introduces functions developed to facilitate systematic yet flexible analyses 
     of data from Twitter.
-License: GPL-3
 Language: en-US
 URL: https://bretsw.github.io/tidytags/, https://github.com/bretsw/tidytags
 Depends: 

R/setup-functions.R

@@ -103,9 +103,10 @@ get_char_tweet_ids2 <-
 #' With a TAGS archive imported into R, \code{pull_tweet_data()} uses the
 #'   **rtweet** package to query the Twitter API. Using rtweet requires Twitter
 #'   API keys associated with an approved developer account. Fortunately, the
-#'   rtweet vignette, \href{https://docs.ropensci.org/rtweet/articles/auth.html}
-#'   {Obtaining and using access tokens}, provides a very thorough guide to
-#'   obtaining Twitter API keys. We recommend the second suggested method listed
+#'   rtweet vignette,
+#'   \href{https://docs.ropensci.org/rtweet/articles/auth.html}{Authentication},
+#'   provides a thorough guide to obtaining Twitter API keys. We recommend
+#'   the second suggested method listed
 #'   in the rtweet vignette, "2. Access token/secret method." Following these
 #'   directions, you will run the \code{rtweet::create_token()} function, which
 #'   saves your Twitter API keys to the \code{.Renviron} file. You can also edit

README.Rmd

@@ -16,18 +16,22 @@ knitr::opts_chunk$set(
 
 # tidytags <img src="man/figures/tidytags-logo.png" align="right" width="120" />
 
+##### Importing and Analyzing Twitter Data Collected with Twitter Archiving Google Sheets
+
 <!-- badges: start -->
-[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/382_status.svg)](https://github.com/ropensci/software-review/issues/382)
+
 [![R-CMD-check](https://github.com/bretsw/tidytags/workflows/R-CMD-check/badge.svg)](https://github.com/bretsw/tidytags/actions)
 [![codecov](https://codecov.io/gh/bretsw/tidytags/branch/master/graph/badge.svg)](https://codecov.io/gh/bretsw/tidytags)
 [![Last-changedate](https://img.shields.io/github/last-commit/bretsw/tidytags.svg)](https://github.com/bretsw/tidytags/commits/main)
-[![GitHub issues](https://img.shields.io/github/issues/bretsw/tidytags.svg?style=popout)](https://github.com/bretsw/tidytags/issues/)
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
+[![GitHub issues](https://img.shields.io/github/issues/bretsw/tidytags.svg?style=popout)](https://github.com/bretsw/tidytags/issues/)
+
 [![license](https://img.shields.io/badge/license-GPL3-9cf.svg)](https://www.gnu.org/licenses/gpl.html)
-<!-- badges: end -->
+[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/382_status.svg)](https://github.com/ropensci/software-review/issues/382)
 
-Importing and Analyzing Twitter Data Collected with Twitter Archiving Google Sheets
+<!-- badges: end -->
 
 ## Overview
 
@@ -58,7 +62,7 @@ library(tidytags)
 
 ## Setup
 
-For help with initial {tidytags} setup, see the [Getting started with tidytags](https://bretsw.github.io/tidytags/articles/setup.html) vignette. Specifically, this guide offers help for four pain points:
+For help with initial {tidytags} setup, see the [Getting started with tidytags](https://bretsw.github.io/tidytags/articles/setup.html) vignette. Specifically, this guide offers help for four key tasks:
 
 1. Making sure your TAGS tracker can be accessed
 2. Getting and storing a Google API key
@@ -97,6 +101,12 @@ If you encounter an obvious bug for which there is not already an [active issue]
 
 If you would like to become a more involved contributor, please read the [Contributing Guide](https://github.com/bretsw/tidytags/blob/master/CONTRIBUTING.md). All contributors, from those fixing typos to adding new functionality, must adhere to the [Code of Conduct](https://github.com/bretsw/tidytags/blob/master/CODE_OF_CONDUCT.md).
 
+## How to cite this package in publications
+
+You can cite this package like this: "we collected, processed, and analyzed Twitter data  using the tidytags R package (Staudt Willet & Rosenberg, 2021)". Here is the full bibliographic reference to include in your reference list:
+
+`r citation("tidytags")`
+
 ## License [![license](https://img.shields.io/badge/license-GPL3-9cf.svg)](https://www.gnu.org/licenses/gpl.html)
 
 The {tidytags} package is licensed under a *GNU General Public License v3.0*, or [GPL-3](https://choosealicense.com/licenses/lgpl-3.0/). For background on why we chose this license, read this chapter on [R package licensing](https://r-pkgs.org/license.html).

README.md

@@ -3,24 +3,26 @@
 
 # tidytags <img src="man/figures/tidytags-logo.png" align="right" width="120" />
 
+##### Importing and Analyzing Twitter Data Collected with Twitter Archiving Google Sheets
+
 <!-- badges: start -->
 
-[![Project Status: Active – The project has reached a stable, usable
-state and is being actively
-developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![Status at rOpenSci Software Peer
-Review](https://badges.ropensci.org/382_status.svg)](https://github.com/ropensci/software-review/issues/382)
 [![R-CMD-check](https://github.com/bretsw/tidytags/workflows/R-CMD-check/badge.svg)](https://github.com/bretsw/tidytags/actions)
 [![codecov](https://codecov.io/gh/bretsw/tidytags/branch/master/graph/badge.svg)](https://codecov.io/gh/bretsw/tidytags)
 [![Last-changedate](https://img.shields.io/github/last-commit/bretsw/tidytags.svg)](https://github.com/bretsw/tidytags/commits/main)
+
+[![Project Status: Active – The project has reached a stable, usable
+state and is being actively
+developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
 [![GitHub
 issues](https://img.shields.io/github/issues/bretsw/tidytags.svg?style=popout)](https://github.com/bretsw/tidytags/issues/)
-[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
+
 [![license](https://img.shields.io/badge/license-GPL3-9cf.svg)](https://www.gnu.org/licenses/gpl.html)
-<!-- badges: end -->
+[![Status at rOpenSci Software Peer
+Review](https://badges.ropensci.org/382_status.svg)](https://github.com/ropensci/software-review/issues/382)
 
-Importing and Analyzing Twitter Data Collected with Twitter Archiving
-Google Sheets
+<!-- badges: end -->
 
 ## Overview
 
@@ -60,7 +62,7 @@ library(tidytags)
 
 For help with initial {tidytags} setup, see the [Getting started with
 tidytags](https://bretsw.github.io/tidytags/articles/setup.html)
-vignette. Specifically, this guide offers help for four pain points:
+vignette. Specifically, this guide offers help for four key tasks:
 
 1.  Making sure your TAGS tracker can be accessed
 2.  Getting and storing a Google API key
@@ -118,7 +120,7 @@ Bret](mailto:[email protected]) or reach out on Twitter:
 You can also [submit an issue on
 Github](https://github.com/bretsw/tidytags/issues/).
 
-You may also wish too try some general troubleshooting strategies:
+You may also wish to try some general troubleshooting strategies:
 
 -   Try to find out what the specific problem is
     -   Identify what is *not* causing the problem
@@ -133,8 +135,9 @@ You may also wish too try some general troubleshooting strategies:
 
 ## Considerations Related to Ethics, Data Privacy, and Human Subjects Research
 
-{tidytags} should be used in strict accordance with Twitter’s [developer
-terms](https://developer.twitter.com/en/developer-terms/more-on-restricted-use-cases).
+**{tidytags} should be used in strict accordance with Twitter’s
+[developer
+terms](https://developer.twitter.com/en/developer-terms/more-on-restricted-use-cases).**
 
 Although most Institutional Review Boards (IRBs) consider the Twitter
 data that {tidytags} analyzes to *not* necessarily be human subjects
@@ -149,7 +152,7 @@ guide](https://devguide.ropensci.org/policies.html#ethics-data-privacy-and-human
 Therefore, although you *can* collect Twitter data (and you *can* use
 {tidytags} to analyze it), we urge care and thoughtfulness regarding how
 you analyze the data and communicate the results. In short, please
-remember that most (if not all) of the you collect may be about
+remember that most (if not all) of the data you collect may be about
 people—and [those people may not like the idea of their data being
 analyzed or included in
 research](https://journals.sagepub.com/doi/full/10.1177/2056305118763366).
@@ -161,10 +164,6 @@ AoIR’s [ethical guidelines](https://aoir.org/reports/ethics3.pdf) may be
 especially helpful for navigating tensions related to collecting,
 analyzing, and sharing social media data.
 
-**{tidytags} should be used in strict accordance with Twitter’s
-[developer
-terms](https://developer.twitter.com/en/developer-terms/more-on-restricted-use-cases).**
-
 ## Contributing
 
 If you encounter an obvious bug for which there is not already an
@@ -179,6 +178,21 @@ All contributors, from those fixing typos to adding new functionality,
 must adhere to the [Code of
 Conduct](https://github.com/bretsw/tidytags/blob/master/CODE_OF_CONDUCT.md).
 
+## How to cite this package in publications
+
+You can cite this package like this: “we collected, processed, and
+analyzed Twitter data using the tidytags R package (Staudt Willet &
+Rosenberg, 2021)”. Here is the full bibliographic reference to include
+in your reference list:
+
+list(title = “tidytags: Importing and Analyzing Twitter Data Collected
+with TwitterGoogle Sheets”, author = list(list(given = “K. Bret”, family
+= “Staudt Willet”, role = c(“aut”, “cre”), email = “<[email protected]>”,
+comment = c(ORCID = “0000-0002-6984-416X”)), list(given = “Joshua M.”,
+family = “Rosenberg”, role = “aut”, email = NULL, comment = c(ORCID =
+“0000-0003-2170-0447”))), year = “2021”, note =
+“<a href="https://bretsw.github.io/tidytags/,\nhttps://github.com/bretsw/tidytags" class="uri">https://bretsw.github.io/tidytags/,\nhttps://github.com/bretsw/tidytags</a>”)
+
 ## License [![license](https://img.shields.io/badge/license-GPL3-9cf.svg)](https://www.gnu.org/licenses/gpl.html)
 
 The {tidytags} package is licensed under a *GNU General Public License