Skip to content

on derived-data/ and raw-data/ sub-folders #71

@avallecam

Description

@avallecam

Hi, thanks for building and maintaining {rcompendium}!

Thanks for reporting at the Changelog that data/ will not contain sub-folders derived-data/ and raw-data/.

Comparing it with a previous version, I found that the subfolder READMEs also no longer contain the previous default writings (e.g., "Do not modify this data").

I found in the code that it still has referrals to the previous behavior at:

if (!is.null(compendium)) {
cli::cat_line()
ui_todo("Put your data in {ui_value('data/raw-data')} directory")
ui_todo("Write your R scripts in the {ui_value('analyses/')} directory")
ui_todo("Source your R scripts in the {ui_value('make.R')} file")
ui_todo(paste0("Export your derived data in the ",
"{ui_value('data/derived-data/')} directory"))
ui_todo("Export your outputs in the {ui_value('outputs/')} directory")
ui_todo("Export your figures in the {ui_value('figures/')} directory")
}

So when I ran:

rcompendium::new_compendium(compendium = c("data/raw-data"))

I got only one folder and the whole message as output

(*) What's next?

• Edit project metadata in 'DESCRIPTION'
• Edit project description in 'README.Rmd'
• Write your R functions in the 'R/' directory

• Put your data in 'data/raw-data' directory
• Write your R scripts in the 'analyses/' directory
• Source your R scripts in the 'make.R' file
• Export your derived data in the 'data/derived-data/' directory
• Export your outputs in the 'outputs/' directory
• Export your figures in the 'figures/' directory

• ...and commit your changes!

Is this possibly an issue?

My question: Are there plans to recover this feature of sub-folders with pre-written READMEs? Is the new recommended workflow to store derived data in the outputs/ folder? I found the previous structure convenient and am now wondering if there is any background rationale I can learn from you.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions