Skip to content

Commit

Permalink
Remove text from README that is not about epidist (#37)
Browse files Browse the repository at this point in the history 
Former-commit-id: be43bba
Former-commit-id: b36c23b6b94a19a056beb431adad2379b1cb56b4
Former-commit-id: e48c47287f3845e38fc32114f7bcc328b76682e6 [formerly 1544f00]
Former-commit-id: f9466689626b955ad67d90de99a3e56b0eaddbb8
  • Loading branch information
@athowes
athowes authored May 15, 2024
1 parent 519cc69 commit cdd6366
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 90 deletions.
27 changes: 0 additions & 27 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,23 +90,8 @@ We also provide a [Docker](https://www.docker.com/get-started/) image with [`epi

</details>


## Resources

As you use the package, the documentation available via `?enw_` should be your first stop for troubleshooting. We also provide a range of other documentation, case studies, and community spaces to ask (and answer!) questions:

<details><summary>Package Website</summary>

The [`epinowcast` website](https://package.epinowcast.org/) includes a function reference, model outline, and case studies using the package. The site mainly concerns the release version, but you can also find documentation for [the latest development version](https://package.epinowcast.org/dev/).

</details>

<details><summary>R Vignettes</summary>

We have created [package vignettes](https://package.epinowcast.org/articles) to help you [get started nowcasting](https://package.epinowcast.org/articles/epinowcast.html) and to [highlight other features with case studies](https://package.epinowcast.org/articles/germany-age-stratified-nowcasting.html).

</details>

<details><summary>Organisation Website</summary>

Our [organisation website](https://www.epinowcast.org/) includes links to other resources, [guest posts](https://www.epinowcast.org/blog.html), and [seminar schedule](https://www.epinowcast.org/seminars.html) for both upcoming and past recordings.
Expand All @@ -119,18 +104,6 @@ Our [community forum](https://community.epinowcast.org/) has areas for [question

</details>

<details><summary>Package Analysis Scripts</summary>

In addition to the vignettes, the package also comes with [example analyses](https://github.com/epinowcast/epinowcast/tree/main/inst/examples). These are not as polished as the vignettes, but we typically explore new features with these and they may help you if you are using a development version. After installing `epinowcast`, you can find them via:

```{r, eval = FALSE}
list.files(
system.file("examples", package = "epinowcast"), full.names = TRUE
)
```

</details>

## Contributing

We welcome contributions and new contributors! We particularly appreciate help on [identifying and identified issues](https://github.com/epinowcast/epidist/issues). Please check and add to the issues, and/or add a [pull request](https://github.com/epinowcast/epidist/pulls) and see our [contributing guide](CONTRIBUTING.md) for more information.
Expand Down
80 changes: 17 additions & 63 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ biased conclusions.
## Installation

<details>

<summary>Installing the package</summary>
<summary>
Installing the package
</summary>

You can install the latest released version using the normal `R`
function, though you need to point to `r-universe` instead of CRAN:
Expand All @@ -49,7 +50,7 @@ install.packages(

Alternatively, you can use the [`remotes`
package](https://remotes.r-lib.org/) to install the development version
from Github (warning\! this version may contain breaking changes and/or
from Github (warning! this version may contain breaking changes and/or
bugs):

``` r
Expand All @@ -73,10 +74,10 @@ if needed, e.g. if you want to try out a specific unreleased feature,
but not the absolute latest developmental version.*

</details>

<details>

<summary>Installing CmdStan</summary>
<summary>
Installing CmdStan
</summary>

If you wish to do model fitting and nowcasting, you will need to install
[CmdStan](https://mc-stan.org/users/interfaces/cmdstan), which also
Expand All @@ -100,10 +101,10 @@ need to install a past version of CmdStan, which you can do with the
`version` argument.*

</details>

<details>

<summary>Alternative: Docker</summary>
<summary>
Alternative: Docker
</summary>

We also provide a [Docker](https://www.docker.com/get-started/) image
with [`epinowcast` and all dependencies
Expand All @@ -114,50 +115,21 @@ You can use this image to run `epidist` without installing dependencies.

## Resources

As you use the package, the documentation available via `?enw_` should
be your first stop for troubleshooting. We also provide a range of other
documentation, case studies, and community spaces to ask (and answer\!)
questions:

<details>

<summary>Package Website</summary>

The [`epinowcast` website](https://package.epinowcast.org/) includes a
function reference, model outline, and case studies using the package.
The site mainly concerns the release version, but you can also find
documentation for [the latest development
version](https://package.epinowcast.org/dev/).

</details>

<details>

<summary>R Vignettes</summary>

We have created [package
vignettes](https://package.epinowcast.org/articles) to help you [get
started
nowcasting](https://package.epinowcast.org/articles/epinowcast.html) and
to [highlight other features with case
studies](https://package.epinowcast.org/articles/germany-age-stratified-nowcasting.html).

</details>

<details>

<summary>Organisation Website</summary>
<summary>
Organisation Website
</summary>

Our [organisation website](https://www.epinowcast.org/) includes links
to other resources, [guest posts](https://www.epinowcast.org/blog.html),
and [seminar schedule](https://www.epinowcast.org/seminars.html) for
both upcoming and past recordings.

</details>

<details>

<summary>Community Forum</summary>
<summary>
Community Forum
</summary>

Our [community forum](https://community.epinowcast.org/) has areas for
[question and answer](https://community.epinowcast.org/c/interface/15)
Expand All @@ -168,27 +140,9 @@ disease, you may find this useful even if do not use `epinowcast`.

</details>

<details>

<summary>Package Analysis Scripts</summary>

In addition to the vignettes, the package also comes with [example
analyses](https://github.com/epinowcast/epinowcast/tree/main/inst/examples).
These are not as polished as the vignettes, but we typically explore new
features with these and they may help you if you are using a development
version. After installing `epinowcast`, you can find them via:

``` r
list.files(
system.file("examples", package = "epinowcast"), full.names = TRUE
)
```

</details>

## Contributing

We welcome contributions and new contributors\! We particularly
We welcome contributions and new contributors! We particularly
appreciate help on [identifying and identified
issues](https://github.com/epinowcast/epidist/issues). Please check and
add to the issues, and/or add a [pull
Expand Down

0 comments on commit cdd6366

Please sign in to comment.