Skip to content

Commit

Permalink
feat: ✨ title field in DESCRIPTION is required by many usethis functi…
Browse files Browse the repository at this point in the history
…ons (#137)

## Description

Title is needed for usethis packages

Closes #133
  • Loading branch information
lwjohnst86 authored Oct 4, 2024
1 parent 62ca2c0 commit 0d2ac7f
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 40 deletions.
96 changes: 56 additions & 40 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# prodigenr (development version)

## Fixes and improvements

- The `title` field in the `DESCRIPTION` file is needed by many
usethis functions, so it is added to the created `DESCRIPTION` file
(#137).

# prodigenr 0.6.2

## Minor changes and CRAN fixes

- Removed Distill from imports and from created report, switching to using Quarto
instead (e.g. with YAML metadata).
- Removed Distill from imports and from created report, switching to
using Quarto instead (e.g. with YAML metadata).
- Removed AppVeyor.
- Rearranged project creation to copy an internal folder (with necessary files)
into the specified folder on the users computer. This hopefully will make it easier
to add other templates later on.
- Rearranged project creation to copy an internal folder (with
necessary files) into the specified folder on the users computer.
This hopefully will make it easier to add other templates later on.
- Updated package aims to be clearer and more focused.
- Fixes to CRAN notes about HTML5.

Expand All @@ -23,82 +29,92 @@ to add other templates later on.

## Major changes

- Removed abstract and poster templates. Abstracts are so small it isn't
an important addition and (I sense) posters will for a while be created
with other software tools (e.g. PowerPoint). Plus there aren't many
mature and well-established poster packages in R at this point in time.
- Removed abstract and poster templates. Abstracts are so small it
isn't an important addition and (I sense) posters will for a while
be created with other software tools (e.g. PowerPoint). Plus there
aren't many mature and well-established poster packages in R at this
point in time.
- Tidied up and trim down all the README files and include pointers to
the prodigenr online documentation instead.
the prodigenr online documentation instead.
- Removed R script template files. Projects might be too diverse for
these template scripts to make sense.
these template scripts to make sense.
- Removed several dependencies, including the usethis package.
- Moved Git initialization setup out into new function called `setup_with_git()`.
- Moved Git initialization setup out into new function called
`setup_with_git()`.

# prodigenr 0.5.0

## Major change

- Switch to having only one argument for `setup_project()` called `path` (#102)
- Switch to having only one argument for `setup_project()` called
`path` (#102)

## Additions

- Can now use RStudio's "New Project" interface for a GUI creation of the project (#109, #111)
- Setup projects to be "blank slates" (i.e. don't save `.RData`) (#105)
- Can now use RStudio's "New Project" interface for a GUI creation of
the project (#109, #111)
- Setup projects to be "blank slates" (i.e. don't save `.RData`)
(#105)
- Add TODO list to project to complete after project creation (#39)

## Hotfix

- Fix NOTES in CRAN results check for unused dependencies (clipr, desc, devtools)
- Fix NOTES in CRAN results check for unused dependencies (clipr,
desc, devtools)

## Misc

- Remove deprecated `prodigen()` function (#107)
- Replace current interactive messaging with `usethis::ui_*` functions
- Reduced opinionated content and moved over to [rostools](https://github.com/rostools/rostools)
and its [manifesto](https://gitlab.com/rostools/manifesto) (#108)
- Reduced opinionated content and moved over to
[rostools](https://github.com/rostools/rostools) and its
[manifesto](https://gitlab.com/rostools/manifesto) (#108)
- Removed some dependencies by using functions from usethis
- Incorporate `use_template()` instead of custom function (#101)

# prodigenr 0.4.0

## New feature

* Use RMarkdown template files to draft the posters, slides, manuscripts, and
abstract (#70, #75). See `create_*` type commands.
* New function to setup a general project, but excluding the individual document
types such manuscript, slides, etc (#72). `prodigen` function is deprecated.
* READMEs in each folder and section to fill out in main README for the project
description (#38, #80).
- Use RMarkdown template files to draft the posters, slides,
manuscripts, and abstract (#70, #75). See `create_*` type commands.
- New function to setup a general project, but excluding the
individual document types such manuscript, slides, etc (#72).
`prodigen` function is deprecated.
- READMEs in each folder and section to fill out in main README for
the project description (#38, #80).

## Removals

* Moved `include_*()` functions over into [rostools](https://github.com/rostools/rostools) (#96)
- Moved `include_*()` functions over into
[rostools](https://github.com/rostools/rostools) (#96)

## Minor fixes

* Added additional information to template README.md (#29, #30, #32)
- Added additional information to template README.md (#29, #30, #32)

## Misc additions

* Todo items to created README
* Added code coverage #65
- Todo items to created README
- Added code coverage #65

# prodigenr 0.3.0

## New features/functionality

* `prodigen()` now creates a new project structure that mimics R package development
more, specifically `devtools` (since it is well documented and actively
maintained) (#18, #15, #14). The old style has been removed.
* Added a function to include a [STROBE](https://www.strobe-statement.org/)
checklist for reporting guidelines (#21).
* Added function to include an `rfigshare` script to send to [figshare](https://figshare.com/) (#19).
* Added function to include a more complete MIT license (#20).
- `prodigen()` now creates a new project structure that mimics R
package development more, specifically `devtools` (since it is well
documented and actively maintained) (#18, #15, #14). The old style
has been removed.
- Added a function to include a
[STROBE](https://www.strobe-statement.org/) checklist for reporting
guidelines (#21).
- Added function to include an `rfigshare` script to send to
[figshare](https://figshare.com/) (#19).
- Added function to include a more complete MIT license (#20).

# prodigenr 0.2.7

* Added a `NEWS.md` file to track changes to the package.
* Fixed a bug that prevented an Rproj file and the Rprofile files from being
installed and created.


- Added a `NEWS.md` file to track changes to the package.
- Fixed a bug that prevented an Rproj file and the Rprofile files from
being installed and created.
1 change: 1 addition & 0 deletions inst/templates/projects/basic-analysis/DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Package: {{ProjectName}}
Title: Analysis Project for {{ProjectName}}
Type: Project
Version: 0.0.1
Imports:
Expand Down

0 comments on commit 0d2ac7f

Please sign in to comment.