9 Appendix

This table describes the 42 functions available in HistText as of November 2023.


Control Functions
   
   
   
accepts_date_queries   
   
Check if a corpus accepts date   queries   
   
get_default_ner_model   
   
Get the name of the default NER   model for a given corpus   
   
get_error_status   
   
Retrieve the error status of a   response.   
   
get_server_status   
   
Get the status of the server   
   
list_corpora   
   
List available collections in SolR   
   
Query Functions   
   
   
   
search_documents   
   
Search for documents   
   
search_documents_ex   
   
Extended Search for documents   
   
search_concordance   
   
KWIC Search In ENP Corpora   
   
search_concordance_ex   
   
Extended KWIC Search In ENP   Corpora   
   
search_concordance_on_df   
   
KWIC search in a custom dataframe   
   
get_documents   
   
Retrieve document from ID   
   
count_documents   
   
Get the number of articles   matching a query, by date   
   
count_search_documents   
   
Count the number of documents that   can be returned by a query   
   
view_document   
   
View a single document in RStudio   
   
Data extraction functions   
   
   
   
ner_on_corpus   
   
Apply Named Entity Recognition on   a corpus   
   
ner_on_df   
   
Apply Named Entity Recognition on   the specified column of a dataframe   
   
run_ner   
   
Apply Named Entity Recognition on   a string   
   
run_qa   
   
Apply Question-Answering on a   string   
   
qa_on_corpus   
   
Apply Named Entity Recognition on   a corpus   
   
qa_on_df   
   
Apply Named Entity Recognition on   the specified column of a dataframe   
   
extract_regexps_from_subcorpus   
   
apply a collection of Regexps to a   collection of documents   
   
Advanced functions   
   
   
   
list_search_fields   
   
List possible search fields for a   given corpus   
   
get_search_fields_content   
   
Retrieve the content associated   with each search field   
   
list_filter_fields   
   
List possible filter fields for a   given corpus   
   
list_ner_models   
   
List available NER models on the   server   
   
list_possible_filters   
   
List possible filter values for a   given filter field   
   
list_precomputed_corpora   
   
List corpora with precomputed   annotations   
   
list_precomputed_fields   
   
List fields of a given corpus that   have precomputed annotations   
   
list_qa_models   
   
List available NER models on the   server   
   
load_pdf_as_df   
   
Load the text from a PDF into a   data frame   
   
proquest_view   
   
Display an entry from ProQuest Corpus   
   
Chinese-specific functions   
   
   
   
list_cws_models   
   
List available CWS models on the   server   
   
run_cws   
   
Apply Chinese Word Segmentation on   a string   
   
get_default_cws_model   
   
Get the name of the default CWS   model for a given corpus   
   
cws_on_corpus   
   
Apply Chinese Word Segmentation on   a corpus   
   
cws_on_df   
   
Apply Chinese Word Segmentation on   the specified column of a dataframe   
   
sinograms_to_py   
   
sinograms(漢字) to pinyin conversion   
   
wade_to_py   
   
wade-giles to pinyin conversion   
   
Graph functions   
   
   
   
get_padagraph_url   
   
Send a tidygraph to padagraph and   return the URL   
   
in_padagraph   
   
Send a tidygraph to padagraph and   displays it   
   
load_in_padagraph   
   
Load and send a previously saved   graph object into padagraph   
   
save_graph   
   
Save a tidygraph into a file   
   
Server functions   
   
   
   
query_server_get   
   
GET a resource from the server   
   
query_server_post   
   
POST a file to the server   
   
set_config_file   
   
Sets the config file in order to   specify the server URL to use (+ other needed information).