Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Analysis projects: Create skeleton docs #2

Open
stephlocke opened this issue Mar 13, 2017 · 7 comments
Open

Analysis projects: Create skeleton docs #2

stephlocke opened this issue Mar 13, 2017 · 7 comments

Comments

@stephlocke
Copy link
Member

Create some templates that can be added to createAnalysisProject

@stephlocke
Copy link
Member Author

Did a PR (#25) to make some packages install by default

@maelle
Copy link
Contributor

maelle commented Nov 20, 2018

Not sure what is to be done for this issue?

@stephlocke
Copy link
Member Author

some vanilla files that are called things like:

  • data_preprocessing.R
  • EDA.R / EDA.Rmd
  • Report.Rmd

so folks could just start filling them out / customising them

@maelle
Copy link
Contributor

maelle commented Feb 5, 2019

The EDA template should include the magical function

DataExplorer::create_report()

Any other must?

@stephlocke
Copy link
Member Author

  • The report.rmd could be a basic rmarkdown file with a set.seed
  • The preprocessing could include some comments like
# library calls - make sure any libraries you need are included in the DESCRIPTION too. Run `usethis::use_package()`
# connections to data sources - consider configuration management so you don't accidentally publish important password etc. Check out packages like `config`
# data processing
# output clean but raw data to the `data/` dir. If the file is big you may need to enable Git LFS before you commit the data!

@maelle
Copy link
Contributor

maelle commented Feb 5, 2019

This package's description should be "All the cool stuff @stephlocke wants you to know about and use" ✨

@stephlocke
Copy link
Member Author

another rename to "stephsays" like cowsays but better! ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants