Skip to content

Commit a99d426

Browse files
committed
Update Description, resubmission info
1 parent db560c4 commit a99d426

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

DESCRIPTION

+10-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,16 @@ Authors@R:
1717
role = "aut",
1818
email = "[email protected]",
1919
comment = c(ORCID = "0000-0002-4985-5160")))
20-
Description: Calculate the log odds ratio, weighted by a prior
21-
such as that from empirical Bayes estimation, using tidy data principles.
20+
Description: How can we measure how the usage or frequency of some feature, such
21+
as words, differs across some group or set, such as documents? One option is
22+
to use the log odds ratio, but the log odds ratio alone does not account for
23+
sampling variability; we haven't counted every feature the same number of
24+
times so how do we know which differences are meaningful? Enter the weighted
25+
log odds, which tidylo provides an implementation for, using tidy data
26+
principles. In particular, here we use the method outlined in Monroe,
27+
Colaresi, and Quinn (2008) <doi:10.1093/pan/mpn018> to weight the log odds
28+
ratio by a prior. By default, the prior is estimated from the data itself,
29+
an empirical Bayes approach, but an uninformative prior is also available.
2230
License: MIT + file LICENSE
2331
URL: http://github.com/juliasilge/tidylo
2432
BugReports: http://github.com/juliasilge/tidylo/issues

cran-comments.md

+30
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,33 @@
88
0 errors | 0 warnings | 1 note
99

1010
* This is a new release.
11+
12+
## 0.1.0 Resubmission
13+
14+
### Review 1 - 2020-05-11
15+
16+
> The Description field is intended to be a (one paragraph) description
17+
of what the package does and why it may be useful. Please elaborate.
18+
19+
Changed the Description from:
20+
21+
"Calculate the log odds ratio, weighted by a prior such as that from empirical Bayes estimation, using tidy data principles."
22+
23+
to:
24+
25+
"How can we measure how the usage or frequency of some feature, such as words, differs across some group or set, such as documents? One option is to use the log odds ratio, but the log odds ratio alone does not account for sampling variability; we haven't counted every feature the same number of times so how do we know which differences are meaningful? Enter the weighted log odds, which tidylo provides an implementation for, using tidy data principles. In particular, here we use the method outlined in Monroe, Colaresi, and Quinn (2008) <doi:10.1093/pan/mpn018> to weight the log odds ratio by a prior. By default, the prior is estimated from the data itself, an empirical Bayes approach, but an uninformative prior is also available."
26+
27+
28+
> If there are references describing (the theoretical backgrounds of) the
29+
methods in your package, please add these in the description field of
30+
your DESCRIPTION file in the form
31+
authors (year) <doi:...>
32+
authors (year) <arXiv:...>
33+
authors (year, ISBN:...)
34+
or if those are not available: <https:...>
35+
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
36+
auto-linking.
37+
38+
Add to the Description:
39+
40+
"...here we use the method outlined in Monroe, Colaresi, and Quinn (2008) <doi:10.1093/pan/mpn018>"

0 commit comments

Comments
 (0)