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

231 add data retrieval via api vignette #260

Merged
merged 36 commits into from
Jun 21, 2024

Conversation

cthunes
Copy link
Contributor

@cthunes cthunes commented May 24, 2024

Closes #231. Added Data Retrieval via API vignette. may need ccdR dev branch to build
Closes #218. Changed tcplConfDefault to use default tcpl API key. Added note to API vignette regarding this.

Copy link
Contributor

@Ashley-Ko Ashley-Ko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few comments regarding the narration of the vignette. Mostly these are missing or extra words.

vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
@cthunes cthunes requested a review from Ashley-Ko June 10, 2024 15:18
…ug-fixes

235 247 248 206 api plotting and bug fixes
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Show resolved Hide resolved
vignettes/Data_retrieval_via_API.Rmd Outdated Show resolved Hide resolved

## Standalone Format Plot with API

Suppose you have a database where you process dose-response data and wish to compare with how it was previously processed in invitrodb v4.1. The API connection supports <font face="CMTT10">tcplPlot</font>'s standalone plotting feature! Using the utility function <font face="CMTT10">tcplPlotLoadData</font> while connected to the API, you can pass along that data to <font face="CMTT10">tcplPlot</font>'s `dat` parameter and use `compare.val` for the database data.
Copy link
Collaborator

@madison-feshuk madison-feshuk Jun 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tcplPlot has been updated for advanced comparison plotting across data connections. If working on a local invitrodb instance, additional dose-response data may be available, data reprocessed, methods adjusted, etc. Users may wish to compare data released in different versions, such as comparing API data or versioned database to one's local invitrodb database.

Using the utility function tcplPlotLoadData while connected to the API, users can pass along data via tcplPlot’s dat parameter and use compare.val for their database data.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this backwards compatible with v3.5? If not, maybe mention that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mentioned "versioned database (invitrodb v4.1 and later)"

@madison-feshuk
Copy link
Collaborator

New default driver seems to be working well to load data from API! To test, I commented out the tcplConf in the TcplFit2 HitCalling Bug Analysis Rmd

Getting the following error when trying to plot:
tcplPlot(type="mc", fld="m4id", val=unique(dat$m4id), output='console')
Error in tcplLegacyPlot() : object 'output' not found

@cthunes
Copy link
Contributor Author

cthunes commented Jun 17, 2024

Getting the following error when trying to plot: tcplPlot(type="mc", fld="m4id", val=unique(dat$m4id), output='console') Error in tcplLegacyPlot() : object 'output' not found

This is because this branch needs to be rebased with dev, which recently had the PR from the plotting updates that supported API plotting.

Copy link
Collaborator

@madison-feshuk madison-feshuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rebasing resolved the plotting error and vignette updates look great. Thank you!

@cthunes cthunes merged commit e9acc99 into dev Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add "Data Retrieval via API" vignette Update default tcpl config file to use API
4 participants