search

UBC-MDS / inference_on_indigenous_vs_non_indigenous_sentence_length_differences

MIT License
3 stars 4 forks source link

Response to the reviews #32

Open showcy opened 2 years ago

showcy commented 2 years ago

I am not sure if we need write the summary of the implements we made based on review or not? But here is my draft. You can add details and then we can reply them in that issue page.

Thank you for all of your comments! We appreciated, agreed with, and implemented some of your comments.

About report

From: @ytz and @nrao944

  • Useful to briefly mention the number of data points on your data set, under the 'Data' subheading.
  • Is it possible to provide dimensions of the data (total number of observations) for each of the groups in the README and the Data Section of the Report? It is noted that you have this available in your discussion.

Our implementation:

From: @adrianne-l

  • In the report Results & Discussion section, would it be a good idea to include some sub-sections to summarise the interim findings to better navigate and follow your flow of result interpretation?

Our implementation:

From: @nrao944

  • Your alternative hypothesis in the report should insert "not" equal, else it exactly matches the null hypothesis.
  • In your report, the number of repeats, appears as N_REPEATS, and not a number.

Our implementation:

About data visualization

From: @ytz

  • Not 100% sure whether the use of 'confidence interval' is correct in "...we noted the large overlap in the confidence intervals between the two groups"
  • For Figure 2, consider using log scale on x-axis for Figure 2 to make the box-plots more prominent
  • Since the focus is on the indigenous group, you could use a monotone colour for the non-indigenous group, and a primary colour like red or blue for the indigenous group. That will make it easier for the reader to interpret the chart

Our implementation:

Review of Milestone 1 from TA @Ivyqiuhan

  • This line can't run: df_init = pd.read_csv('../data/offender_profile.csv', sep=r'\s,\s', header=0, encoding='ascii', engine='python') because your file is at this path '../data/RAW/offender_profile.csv'
  • I can't run your code it has KeyError: 'Sentence Type' at cell 10

Our implementation:

  • If figure captions are not provided the plot should be clearly explained in the text. I would recommend using figure captions.

Our implementation:

  • Need to add some explanation to the plot and your code

Our implementation:

Review of Milestone 2 from TA @Ivyqiuhan

  • You should create an environment.yaml file to contain all your dependencies

Our implementation:

  • In usage, should write how to run each of your scripts, not just "make all" and "make clean"

Our implementation:

Ivyqiuhan commented 2 years ago

Looks good to me, thanks!

AraiYuno commented 2 years ago

Thanks @showcy !