cardiffr / tdor Goto Github PK

Should we just include the original Age (character) and an Age_numeric variable (mid-range/best guess?).

Make sure we have good description of each variable. Include a simple example. Is a reference the right way to note the source?

For the 2018 hackathon @sastoudt wrote a Shiny dashboard, see here: https://github.com/rlgbtq/TDoR2018/tree/master/shinyDashboard

We can add this to the package and make sure it works with the updated data.

Where does this variable come from? Is there still an issue reading in the dates?

@annajayne has now added an API to https://tdor.translivesmatter.info/. So it would be good to add a function/functions to make it easier to query the API.

Some initial scripts showing how to query the API are available here:

https://tdor.translivesmatter.info/api/example/api_example_single_report_detail.r.txt
https://tdor.translivesmatter.info/api/example/api_example_multiple_reports.r.txt

To use the API you will need to register an account and use the API Key shown on the welcome page.

To register or login visit: tdor.translivesmatter.info/account/ (please wait until you are at the hackathon as there is no email notification yet, so @annajayne will have to watch the logs to activate your account)

Hi , I worked with the data on #tidytuesday last TDOR ,

Think you can really improve the dataset by adding a 3 letter code for countries (iso_a3) country codes.

you can check my contribution on:
https://github.com/jas1/tidytuesday/tree/master/jas1_weeks/2018-11-20

if you prefer a PR , just tell me ill fork and add the suggestion, but preferred just to check with you before doing the thing.

any comments you can reach me here or twitter.

I've been exploring the magick package and it will allow the assembly of gifs.
These could be made programmatically with selections based on country etc...

The help file for the tdor data set needs updating since the data has changed. It would be great if we can find a way to automatically update some parts:

• number of rows and columns
• date range (in years?)

cf #16 for details of the API.

This will help us solve #3 - we might be able to add a function to grab a photo or photos.

@brennanpincardiff can you add your details to the authors field

Create a hex sticker for the package! This could be added to the README (c.f. #22) and pkgdown site (c.f. #24).

See https://github.com/GuangchuangYu/hexSticker

See Make your repo contribution and collaboration friendly.

Would be nice to add a simple example to the tdor helpfile, e.g. a simple visualisation of the data for the most recent TDoR period.

Even if we don't add custom a function/functions to query the tdor.translivesmatter.info API, we can add a vignette with some example queries c.f. #16

See Make your repo contribution and collaboration friendly.

This is not yet on CRAN. Not sure if we can submit to CRAN suggesting a package that is on GitHub. Maybe we can put this example in a separate Rmd on rlgbtq/TDoR2018.

The tdor data set now contains data from 1970. The Transgender Day of Remembrance didn't start until Nov 1999 and it took a while for the official period to settle down to the current one (1 October one year to 30 September the next).

Therefore it might be useful to have a dataset of the TDoR start and end dates, so that we can automatically add the TDoR period to the tdor data. This will require some research by looking at the TDoR PDFs on:
https://transrespect.org/en/trans-murder-monitoring/tmm-resources/

Prior to that just

• treat as missing?
• use other dates from other sources?
• use regular dates?

If regular dates are used, we won't need a dataset of start and end dates, we can just use the fixed start and end dates to define the period for all years. So need to look into this some more.

Improve the README to give a bit more information about the package, e.g.

• current data available
• additional features (API functions, dashboard, if added)
• example of how to install and basic use (could use same example as #21)

Using usethis::use_readme_rmd() is a good idea as it creates a template and also a git hook to make sure the .Rmd file is rendered to .md before being committed.

We should use continuous integration to make sure that when changes are made the examples and vignette still work, the documentation is still in sync, etc.

Maybe we can do it using GitHub actions, e.g. the simple workflow suggested here: https://github.com/r-lib/actions/tree/master/examples#quickstart-ci-workflow

As suggested by @jas1, add 3 letter code for countries (iso_a3).

This should be done in the script that prepares the raw data: https://github.com/CaRdiffR/tdor/blob/master/data-raw/tdor.R

Possibly overkill for this package, but maybe not when we have added more vignettes/functionality!

The content is automatically generated from the README, vignette, helpfiles, etc, so it should not be a big task to create one based on the defaults at least.

We can use GitHub actions to automatically rebuild it for us when something changes:
https://github.com/r-lib/actions/tree/master/examples#build-pkgdown-site