search

ds4owd-001 / project-Otim-Haron

This project was prepared for the data science for openwashdata course
https://ds4owd-001.github.io/project-Otim-Haron/
0 stars 0 forks source link

More clarity on the report format #3

Closed Otim-Haron closed 7 months ago

Otim-Haron commented 7 months ago

@larnsce @mianzg @sskorik01 I need some clarity on the format for producing the report. It's unclear to me because in the project index.qmd file, we were given directives of importing the dataset and defining the project objectives, then when it comes to the requirements we find chapters like introduction that must be included in this same report.

when rendered, what should appear first? Is it the project descriptions, importing, and cleaning etc or we start with Intoduction as a heading and then insert code chunks along the way?

larnsce commented 7 months ago

Thanks for your question, @Otim-Haron.

You can include the data cleaning that leads to your analysis-ready processed data in the same report. If you do so, then it would probably be best to not show the code output of those code chunks.

You can also do the data cleaning that leads to your analysis-ready processes data in a separate file, either .qmd or .R file works. Then you read your analysis-ready processed data from your index.qmd and you go straight into analysis (summary tables, figures, etc.).

I will leave it up to you to decide which workflow works best for you.

We are asking for the secions headings, so that every report has the same structure for the written narrative. It follows a typical scientific report/paper outline.