carlosparadis commented 8 months ago

As agreed on call, please use this space to post your user experience reports (one post per report). For user questions, please use Discussions -> Q&A. Also welcome to post questions about this issue associated with the tasks.

ian-lastname commented 8 months ago

[x] https://github.com/sailuh/kaiaulu/discussions/264 - A part of the problem here is that I didn't exactly understand what ../.. meant. Because of this, I was not aware of where to put correctly put the missing directory that the function needed to actually run.
[x] https://github.com/sailuh/kaiaulu/discussions/265 - Error message isn't really helping me identify the problem nor does it clue me in on how to fix it.
[x] https://github.com/sailuh/kaiaulu/discussions/264 - I've noticed that when it gives an "error in system2 (A, ...)", it usually means that A cannot be found because the directory is wrong or the file isn't there in the first place.
[x] https://github.com/sailuh/kaiaulu/discussions/265 - I've noticed that in gitlog_showcase.Rmd, when you try to run chunk with lines 110-117 multiple times, then it WILL give out an error after the first time even if it succeeds. I don't think it should be detrimental, but I thought that I should note it. (In hindsight, this is probably just related to me not getting or pathing the dependencies correctly)

Ssunoo2 commented 8 months ago

devtools::test()

263 devtools::test() returned several failures and after receiving help through the discussions tab and installing third-party dependencies, I was able to fix most of them.

Perhaps more descriptive error messages such as “this failed because you did not install tool x” would be helpful. Many of the failures were fixed after installing third party apps, though the response in the discussion tab was helpful.

missing functions in kaiaulu_architecture.rmd

271 As a new user to Rstudio, I had assumed that the missing functions were defined in another file in the project similar to a webdev app. I found that I was missing packages after some googling. I also looked at the require methods on the top, which indicated some missing requirements, though this was only an 'alright' indicator as the requirements shared some similarities with the function names but were not identical. Eg. "missing funcition: visIgraph" was in the package "visNetwork"

Perceval Install

Instalingl the third party tools: https://github.com/sailuh/kaiaulu/wiki/Third-Party-Tools-Setup One note is that the instruction for installing perceval did not work as described on the third party tools tab. Changing the ‘=’ to ‘==’ fixed the problem and perceval was installed without a hitch. I am using the Terminal on a Mac so I am not sure if this is a unique distinction for my situation.

pip3 install perceval=0.12.24 should be pip3 install perceval==0.12.24

I didn’t have any issues with the other third party tools, though.

difficulty downloading data

https://github.com/sailuh/kaiaulu/discussions/264#discussion-6133995 I had difficulty downloading data. First, the file structure was difficult to figure out. The default for most downloads was something like ../../rawdata/ and it was confusing which directory I was currently working in. The file browser in Rstudio would be in one file and the getwd() command would show that I was working in a different file, so I changed the filepaths in the config files manually to something like ~/CAPTSTONE496/rawdata/something so I wouldn't even have to think about my working directory.

The data also didn't download when I pressed "run all". Running each chunk one at a time initiated the download process, though the process took a long time to download the files. I think that there could be a message saying "download in process. This may take a while depending on how many issues are extracted" or something like that. The docs could also maybe advise running each chunk one at a time and/or warn that downloads may take some time.

line_metric_showcase.rmd

https://github.com/sailuh/kaiaulu/discussions/273#discussion-6165072 Line 93 had an error due to the scc path. The third party tools on the wiki links to the release version and prompts you to download it. I had downloaded the source code file instead of the proper file and resulted in not having a binary in that file to path to. Perhaps a note to explicitly not download the source file would be useful.

anthonyjlau commented 8 months ago

[x] #266 This issue was due to incorrect paths of perceval and git_repo_path. At first, I thought that the "rawdata" folder would be automatically created when I ran the program but I later found out that I had to create that folder myself. I also found it hard to understand the ".." folder that was default in all of the config files. I found it much easier to replace the default path entirely with my own file path that did not use "..".
[x] #267 I was unaware of the "ls -a" command that showed the hidden folders. I also did not know that I had to create the token file myself and paste my token in that file.
[x] #270 I had errors with downloading igraph for my system. When I tried to run install.packages("igraph"), it would give me an error that I do not remember. So, I looked online and found a stack overflow forum explaining how to download igraph with the console.
[x] #272 This issue is similar to #266 because I did not understand the ".." folder in the config files. After I had changed the default paths to direct paths and creating the missing folders, the issues were solved.
[x] #274 I did not know that I had to download a .mbox file before running this vignette. I tried running the download_mod_mbox.Rmd to download .mbox files but they were not the correct files. I later found in the geronimo config file that there was a link for the geronimo mailbox where I could download it there.

sailuh / kaiaulu