databrary/databraryr

databraryr

databraryr's Issues

`devtools::check(remote = TRUE, manual = TRUE)` reveals a set of HTML issues with the documentation files.

Add NEWS.md

Add download_*.zip functions

Plan roadmap

Migrate analytics to databrary GitHub organization

Remove Databrary cookie at end of test()

How do we remove the Databrary cookie generated by running tests on the login_db() function?

How to determine volume from session/slot ID

The API returns assets from session/slots without requiring the volume, but it would be useful to have the volume ID available as metadata or for the file name.

Build issues: "no visible binding for global variable"

Evaluate feasibility of replacing list_session_in_volume() calls with list_sessions()

When Databrary storage issue has resolved, re-run `urlchecker::url_check()`.

I suspect the calls are timing out.

Fix GitHub actions rendering of pkgdown documentation

Error looks like there is a missing dependency on rmarkdown.

v0.5.1

Evaluate feasibility of new upload_ or edit_ functions

Generate critical feature list

Review authentication functions and clean-up, as needed.

R/config_passwd.R
R/db_login.R
R/db_logout.R

Finish debugging & testing login_db()

I discovered some anomalies in testing the function. I added some debugging messages, made some flag calls more explicit, and made SERVICE an input parameter. But in testing I got 400 errors, so I have to wait to finish testing.

Change "master" branch to "main"

When we're at a good place to change our repos, we should rename the "master" branch to "main".

See: https://github.com/github/renaming

Address to-dos from CRAN review

Thanks,

Please always write package names, software names and API (application
programming interface) names in single quotes in title and description.
e.g: --> 'Databrary.org'
Please note that package names are case sensitive.

It seems like you have too many spaces in your description field.
Probably because linebreaks count as spaces too.
Please remove unecassary ones.

Please add \value to .Rd files regarding exported methods and explain
the functions results in the documentation. Please write about the
structure of the output (class) and also what the output means. (If a
function does not return a value, please document that too, e.g.
\value{No return value, called for side effects} or similar)
Missing Rd-tags:
check_ssl_certs.Rd: \value

Please put functions which download data in \donttest{}.

You write information messages to the console that cannot be easily
suppressed.
It is more R like to generate objects that can be used to extract the
information a user is interested in, and then print() that object.
Instead of print()/cat() rather use message()/warning() or
if(verbose)cat(..) (or maybe stop()) if you really have to write text to
the console. (except for print, summary, interactive functions) ->
R/list_volume_metadata.R

Please fix and resubmit.

Best,
Benjamin Altmann

Add NSF grant award functionality

Reconcile list_*, get_*, and download_* functions

The terminology is inconsistent.

Modify download_party_avatar() to download file.

Currently, download_party_avatar() displays the avatar (as a tibble!), but does not download it.

Explore uses of av package or similar ones within databraryR

https://docs.ropensci.org/av/

Fix logout_db() bug

Session token remains when logging out.

Review existing codebase

Complete CRAN pre-submission checklist

Prepare for release:

[x] git pull
[x] Check if any deprecation processes should be advanced, as described in Gradual deprecation
[x] usethis::use_github_links()
[x] urlchecker::url_check()
[x] devtools::check(remote = TRUE, manual = TRUE)
[x] devtools::check_win_devel()
[x] git push
[x] Merge branch with main
[ ] Draft blog post
[ ] Submit to CRAN:

[ ] usethis::use_version('minor')
[ ] devtools::submit_cran()

Approve email

Release databraryr 0.5.0

First release:

• usethis::use_news_md()
• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• usethis::use_github_links()
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('minor')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Add preemptive link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• usethis::use_news_md()
• Finish blog post
• Tweet

Fix authentication in download_session_csv for non-public files

Advise on how to handle works-in-progress (WIP)

Some functions are still in development and not ready for primetime. How to handle this?

I've dumped them in R/_wip.R for now, but this doesn't seem like the best approach.

Expand test coverage for download_* functions

Complete CRAN checklist

Finish migration from old repo, name change

Upgrade README.md

Expand vignette coverage

Make functions accept lists

Change parameter checks to use assertthat

Move Datavyu functions to new, separate repo

dv_to_csv(), extract_dv_code_defs(), extract_dv()

Enhance search by keyword, search by tag to return matching volumes

Currently, search_for_keywords() and search_for_tags() return the keywords and tags.

Extract function-specific tests into independent R files

This is recommended practice in https://r-pkgs.org/testing-basics.html#create-a-test

Fix GitHub actions rendering of pkg_down documentation

Expand functionality to more closely mirror emerging schema

Create documentation using pkgdown

Remove redundant functions

• download_containers_records(); duplicates list_containers_records()
• download_party_json(); duplicates functionality in download_party()
• download_video() may duplicate download_asset()