Skip to content

Commit

Permalink
fill in basic metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpcouch committed Apr 11, 2024
1 parent 0255eea commit a2d23b8
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 33 deletions.
14 changes: 9 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
Package: container
Title: What the Package Does (One Line, Title Case)
Title: Sandbox for a postprocessor container.
Version: 0.0.0.9000
Authors@R:
person("First", "Last", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "YOUR-ORCID-ID"))
Description: What the package does (one paragraph).
Authors@R: c(
person("Simon", "Couch", , "[email protected]", role = "aut"),
person("Hannah", "Frick", , "[email protected]", role = "aut"),
person("Emil", "HvitFeldt", , "[email protected]", role = "aut"),
person("Max", "Kuhn", , "[email protected]", role = c("aut", "cre")),
person(given = "Posit Software, PBC", role = c("cph", "fnd"))
)
Description: Sandbox for a postprocessor container.
License: MIT + file LICENSE
Suggests:
testthat (>= 3.0.0)
Expand Down
30 changes: 2 additions & 28 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,40 +19,14 @@ knitr::opts_chunk$set(
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/container)](https://CRAN.R-project.org/package=container)
[![R-CMD-check](https://github.com/tidymodels/container/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/container/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/tidymodels/container/branch/master/graph/badge.svg)](https://app.codecov.io/gh/tidymodels/container?branch=master)
<!-- badges: end -->

The goal of container is to ...
The goal of container is to provide a container for postprocessing.

## Installation

You can install the development version of container like so:

``` r
# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?
pak::pak("tidymodels/container")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(container)
## basic example code
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.

You can also embed plots, for example:

```{r pressure, echo = FALSE}
plot(pressure)
```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# container

<!-- badges: start -->

[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN
status](https://www.r-pkg.org/badges/version/container)](https://CRAN.R-project.org/package=container)
[![R-CMD-check](https://github.com/tidymodels/container/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tidymodels/container/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of container is to provide a container for postprocessing.

## Installation

You can install the development version of container like so:

``` r
pak::pak("tidymodels/container")
```

0 comments on commit a2d23b8

Please sign in to comment.