Skip to content

Commit 98c46fc

Browse files
author
Keith Goldfeld
committed
Updating DESCRIPTION and README
1 parent 2ded7d1 commit 98c46fc

File tree

3 files changed

+22
-25
lines changed

3 files changed

+22
-25
lines changed

.Rbuildignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@
2323
^touchstone$
2424
^bench$
2525
^CITATION\.cff$
26+
^README\.md$
27+
^NEWS\.md$

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Type: Package
22
Package: simstudy
33
Title: Simulation of Study Data
4-
Version: 0.3.0.9000
5-
Date: 2021-11-04
4+
Version: 0.4.0
5+
Date: 2022-01-18
66
Authors@R:
77
c(person(given = "Keith",
88
family = "Goldfeld",

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,14 @@ simstudy
22
================
33

44
<!-- README.md is generated from README.Rmd. Please edit that file -->
5-
65
<!-- badges: start -->
76

8-
[![R build
9-
status](https://github.com/kgoldfeld/simstudy/workflows/R-CMD-check/badge.svg?branch=main)](https://github.com/kgoldfeld/simstudy/actions)
10-
[![CRAN
11-
status](https://www.r-pkg.org/badges/version/simstudy)](https://CRAN.R-project.org/package=simstudy)
12-
[![status](https://joss.theoj.org/papers/10.21105/joss.02763/status.svg)](https://joss.theoj.org/papers/10.21105/joss.02763)
13-
[![CRAN
14-
downloads](https://cranlogs.r-pkg.org/badges/grand-total/simstudy)](https://CRAN.R-project.org/package=simstudy)
15-
[![codecov](https://app.codecov.io/gh/kgoldfeld/simstudy/branch/main/graph/badge.svg)](https://app.codecov.io/gh/kgoldfeld/simstudy)
16-
[![Lifecycle:
17-
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
7+
<a href="https://github.com/kgoldfeld/simstudy/actions" target="_blank"><img src="https://github.com/kgoldfeld/simstudy/workflows/R-CMD-check/badge.svg?branch=main" alt="R build status" /></a>
8+
<a href="https://CRAN.R-project.org/package=simstudy" target="_blank"><img src="https://www.r-pkg.org/badges/version/simstudy" alt="CRAN status" /></a>
9+
<a href="https://joss.theoj.org/papers/10.21105/joss.02763" target="_blank"><img src="https://joss.theoj.org/papers/10.21105/joss.02763/status.svg" alt="status" /></a>
10+
<a href="https://CRAN.R-project.org/package=simstudy" target="_blank"><img src="https://cranlogs.r-pkg.org/badges/grand-total/simstudy" alt="CRAN downloads" /></a>
11+
<a href="https://app.codecov.io/gh/kgoldfeld/simstudy" target="_blank"><img src="https://app.codecov.io/gh/kgoldfeld/simstudy/branch/main/graph/badge.svg" alt="codecov" /></a>
12+
<a href="https://lifecycle.r-lib.org/articles/stages.html" target="_blank"><img src="https://img.shields.io/badge/lifecycle-stable-brightgreen.svg" alt="Lifecycle: stable" /></a>
1813
<!-- badges: end -->
1914

2015
The `simstudy` package is a collection of functions that allow users to
@@ -44,7 +39,7 @@ So, the parameterization of some of the data generating processes may
4439
not follow the standard parameterizations for the specific
4540
distributions. For example, in `simstudy` *gamma*-distributed data are
4641
generated based on the specification of a mean μ (or log(μ)) and a
47-
dispersion \(d\), rather than shape α and rate β parameters that more
42+
dispersion *d*, rather than shape α and rate β parameters that more
4843
typically characterize the *gamma* distribution. When we estimate the
4944
parameters, we are modeling μ (or some function of μ), so we should
5045
explicitly recover the `simstudy` parameters used to generate the model,
@@ -56,13 +51,14 @@ page](https://kgoldfeld.github.io/simstudy/articles/simstudy.html).
5651
## Installation
5752

5853
You can install the released version of simstudy from
59-
[CRAN](https://CRAN.R-project.org) with:
54+
<a href="https://CRAN.R-project.org" target="_blank">CRAN</a> with:
6055

6156
``` r
6257
install.packages("simstudy")
6358
```
6459

65-
And the development version from [GitHub](https://github.com/) with:
60+
And the development version from
61+
<a href="https://github.com/" target="_blank">GitHub</a> with:
6662

6763
``` r
6864
# install.packages("devtools")
@@ -101,15 +97,14 @@ dd
10197
## Contributing & Support
10298

10399
If you find a bug or need help, please file an issue with a
104-
[reprex](https://www.tidyverse.org/help/) on
105-
[Github](https://github.com/kgoldfeld/simstudy/issues). We are happy to
106-
accept contributions to simstudy. More information on how to propose
107-
changes or fix bugs can be found
108-
[here](https://kgoldfeld.github.io/simstudy/CONTRIBUTING.html).
100+
<a href="https://www.tidyverse.org/help/" target="_blank">reprex</a> on
101+
<a href="https://github.com/kgoldfeld/simstudy/issues" target="_blank">Github</a>.
102+
We are happy to accept contributions to simstudy. More information on
103+
how to propose changes or fix bugs can be found
104+
<a href="https://kgoldfeld.github.io/simstudy/CONTRIBUTING.html" target="_blank">here</a>.
109105

110106
## Code of Conduct
111107

112-
Please note that the simstudy project is released with a [Contributor
113-
Code of
114-
Conduct](https://kgoldfeld.github.io/simstudy/CODE_OF_CONDUCT.html). By
115-
contributing to this project, you agree to abide by its terms.
108+
Please note that the simstudy project is released with a
109+
<a href="https://kgoldfeld.github.io/simstudy/CODE_OF_CONDUCT.html" target="_blank">Contributor Code of Conduct</a>.
110+
By contributing to this project, you agree to abide by its terms.

0 commit comments

Comments
 (0)