Skip to content

Adjust README to chosen file structure #152

@bbartholdy

Description

@bbartholdy

This is a very small thing and may not be worth implementing, but maybe worth bringing attention.

Following a call to use_readme_rmd(), the generated README will include the ## Contents section with a reference to the analysis directory. However, the user is also given the option to use "inst" and "vignettes" as location arguments in the use_analysis() function. This will result in broken links in the "## Contents" section of the generated README files.

## Contents

The **analysis** directory contains:

- [:file_folder: paper](/analysis/paper): R Markdown source document for
  manuscript. Includes code to reproduce the figures and tables
  generated by the analysis. It also has a rendered version,
  `paper.docx`, suitable for reading (the code is replaced by figures
  and tables in this file)
- [:file_folder: data](/analysis/data): Data used in the analysis.
- [:file_folder: figures](/analysis/figures): Plots and other
  illustrations
- [:file_folder:
  supplementary-materials](/analysis/supplementary-materials):
  Supplementary materials including notes and other documents prepared
  and collected during the analysis.

A quick solution would just be to add a warning that users may need to fix these links when using the "inst" and "vignettes" arguments.

A more comprehensive solution would be to generate the README filepaths based on what structure the user has already implemented (i.e. analysis/ or inst/). Although I'm not sure how feasible this is (for example if the user generates the README before using use_analysis()).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions